Skip to main content
ZStack
Infrastructure/Lifecycle

ScaleCluster

Scale the cluster from single-node deployment to HA by adding nodes

POST/api/v1/lifecycle/components/scale

Operation ID

ScaleCluster

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

Body Fields

  • nodes
    ListRequired

    Nodes to add before scaling the cluster to HA

    Example: (nested array)

    • host
      String

      Host or IP address of the node to add

      Example: 172.24.253.84

    • sshPort
      Integer

      SSH port of the node to add

      Example: 22

    • sshUser
      String

      SSH user for deploying LCA on the node

      Example: root

    • sshPassword
      String

      SSH password for deploying LCA on the node

      Example: value

    • sshKey
      String

      SSH private key for deploying LCA on the node

      Example: value

    • sshHostKey
      String

      Pinned SSH host public key for verifying the node before sending credentials

      Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task ID tracking the asynchronous cluster scale operation

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