API reference / Auto-scaler

Auto-scaler

Runtime configuration and status of the transcoder instance auto-scaler.

GET /api/v1/scaler/config

Get auto-scaler configuration.

Response

Response 200 (application/json)
{
  "maxInstances": 0,
  "minInstances": 0,
  "idleTimeoutMs": 0
}

PATCH /api/v1/scaler/config

Update auto-scaler configuration at runtime (`maxInstances`, `minInstances`, `idleTimeoutMs`).

Request

Request body (application/json)
{
  "maxInstances": 0,
  "minInstances": 0,
  "idleTimeoutMs": 0
}

Response

Response 200 (application/json)
{
  "maxInstances": 0,
  "minInstances": 0,
  "idleTimeoutMs": 0
}

GET /api/v1/scaler/status

Current transcoder instance pool status (effective `maxInstances`, `idleTimeoutMs`).

Response

Response 200 (application/json)
{
  "workspaces": [
    {
      "workspaceId": "string",
      "queueDepth": 0,
      "inflightDepth": 0,
      "instances": [
        {
          "instanceId": null,
          "url": null,
          "activeJobs": null,
          "lastIdleAt": null
        }
      ]
    }
  ],
  "maxInstances": 0,
  "idleTimeoutMs": 0,
  "scalerActive": true
}
← PreviousTranscoder jobsNext →Retention