Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Clusters

Scale a cluster's replica count

POST
/v1/clusters/{id}/scale
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/clusters/string/scale" \  -H "Content-Type: application/json" \  -d '{    "replicaCount": 4  }'
{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "status": "string",
  "gpuModelId": "string",
  "replicaCount": 0,
  "activeReplicas": 0,
  "endpointUrl": "string",
  "createdAt": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl clusters scale <id> --replica-count <replica-count>