Skip to main content
ZStack
Infrastructure/Agents

TokenBatchUpgrade

Submit a batch upgrade job for a list of agents to a specified target version

POST/api/v1/agents/batch-upgrade

Operation ID

TokenBatchUpgrade

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

  • agentUuids
    ListRequired

    Agent uuids

    Example: item1,item2

  • targetVersion
    StringRequired

    Target version to upgrade the selected agents to

    Example: 1.5.0

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of the upgrade job

    Example: upgrade-job-001

  • targetVersion
    String

    Target version all agents are being upgraded to

    Example: 1.5.0

  • agents
    List

    Agents for this resource

    Example: (nested array)

    • agentUuid
      String

      UUID of the agent on the upgraded node

      Example: agent-abc123-def456

    • oldVersion
      String

      Version the agent was running before upgrade

      Example: 1.4.2

    • newVersion
      String

      Version the agent was upgraded to

      Example: 1.5.0

    • status
      String

      Result status of the upgrade (success, failed)

      Example: success

    • error
      String

      Error message if the upgrade failed

      Example: connection refused

  • status
    String

    Overall status of the upgrade job (pending, running, success, failed)

    Example: running

  • simulated
    Boolean

    Whether this job is a simulation without actual upgrade

    Example: false

  • createdAt
    String

    Created at

    Example: 2026-01-15T08:00:00Z

  • completedAt
    String

    Completed at

    Example: 2026-01-15T08:00:00Z