Skip to main content
ZStack
Infrastructure/Agents

LifecycleBatchUpgrade

Initiate a batch upgrade for multiple agents with configurable concurrency

POST/api/v1/agents/lifecycle/batch-upgrade

Operation ID

LifecycleBatchUpgrade

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

  • agentIds
    ListRequired

    Agent ids

    Example: item1,item2

  • toVersion
    StringRequired

    Target version to upgrade selected agents to

    Example: 1.5.0

  • artifactUrl
    StringRequired

    URL to download the upgrade artifact from

    Example: https://artifacts.example.com/agent-1.5.0.tar.gz

  • checksum
    StringRequired

    SHA256 checksum for verifying the upgrade artifact

    Example: sha256:abc123def456

  • concurrency
    IntegerRequired

    Maximum number of agents to upgrade simultaneously

    Example: 5

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • batchId
    String

    Batch identifier for tracking the multi-agent upgrade operation

    Example: batch-upg-001