Skip to main content
ZStack
Infrastructure/Lifecycle

ScaleComponent

Scale a component to the specified number of replicas

POST/api/v1/lifecycle/components/{uuid}/scale

Operation ID

ScaleComponent

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • uuid
    StringRequired

    UUID of the component to scale

Body Fields

  • replicas
    IntegerRequired

    Desired number of replicas for the component

    Example: 3

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task ID tracking the asynchronous scale operation

    Example: task-a1b2c3d4-e5f6-7890-abcd-ef1234567890