List GPU Nodes

Use this endpoint to list every GPU node in your Aria Compute PIN cluster. Each node entry includes connection details, labels, current status, and the number of deployed agents.

Endpoint

GET /v1/gpu-nodes Authorization: Bearer API key required.

Response

array

required

List of GPU node objects.

Show child attributes

string

required

Node identifier, e.g. gn_abc123de.

string

required

Human-readable node name.

string

required

Node IP address used for SSH.

integer

SSH port (defaults to 22).

string

required

SSH username.

string

Hardware or configuration spec summary.

array of strings

Scheduling labels.

string

Node status, e.g. active.

integer

Number of agents deployed on this node.

string (ISO 8601)

Creation timestamp.

string (ISO 8601)

Last update timestamp.

Example

curl -s http://<pin-host>:8001/v1/gpu-nodes \
  -H "Authorization: Bearer $ARIA_PIN_KEY"

{
  "items": [
    {
      "id": "gn_a1b2c3d4",
      "name": "node-01",
      "ip": "10.0.1.10",
      "ssh_port": 22,
      "ssh_user": "ubuntu",
      "spec": "A100-80G x8",
      "labels": ["training", "a100"],
      "status": "active",
      "agent_count": 2,
      "created_at": "2024-05-01T12:00:00Z",
      "updated_at": "2024-05-10T08:30:00Z"
    }
  ]
}

PIN API

ROUTER API

AGENT API

Endpoint

Response

Example

​Endpoint

​Response

​Example

Endpoint

Response

Example