Clusters

Get a cluster with its replicas and GPU model

GET
/v1/clusters/{id}/detail
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/clusters/string/detail"
{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "status": "string",
  "statusReason": "string",
  "gpuModelId": "string",
  "gpusPerReplica": 0,
  "resourceSize": "string",
  "replicaCount": 0,
  "tier": "string",
  "preferredRegions": [
    "string"
  ],
  "allowFallback": true,
  "imageUrl": "string",
  "envVars": {
    "property1": "string",
    "property2": "string"
  },
  "containerPort": 0,
  "healthChecks": [
    "string"
  ],
  "healthCheckPath": "string",
  "healthCheckPort": 0,
  "diskSizeGb": 0,
  "privileged": true,
  "notes": "string",
  "endpointUrl": "string",
  "deployToken": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "gpuModel": {
    "id": "string",
    "name": "string",
    "manufacturer": "string",
    "vramGb": 0,
    "architecture": "string",
    "hidden": true,
    "createdAt": "string"
  },
  "replicas": [
    {
      "id": "string",
      "nodeId": "string",
      "gpuCount": 0,
      "status": "string",
      "healthy": true,
      "lastHealthCheckAt": "string",
      "consecutiveFailures": 0,
      "internalIp": "string",
      "port": 0,
      "endpointUrl": "string",
      "sshPort": 0,
      "startedAt": "string",
      "createdAt": "string",
      "diskUsedBytes": 0,
      "diskTotalBytes": 0,
      "diskUpdatedAt": "string",
      "nvlinkEnabled": true,
      "nodeHostname": "string",
      "nodeLocation": "string",
      "nodeRegion": "string"
    }
  ]
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}