Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
POSTAgentSince 1.0SynchronousAuth Required

LifecycleBatchUpgrade

Initiate a batch upgrade for multiple agents with configurable concurrency

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • agentIdsListRequired

    Agent ids

    Example: item1,item2

  • toVersionStringRequired

    Target version to upgrade selected agents to

    Example: 1.5.0

  • artifactUrlStringRequired

    URL to download the upgrade artifact from

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

  • checksumStringRequired

    SHA256 checksum for verifying the upgrade artifact

    Example: sha256:abc123def456

  • concurrencyIntegerRequired

    Maximum number of agents to upgrade simultaneously

    Example: 5

Responses

200 OK

On success, this API returns the following response structure.

  • batchIdString

    Batch identifier for tracking the multi-agent upgrade operation

    Example: batch-upg-001

Endpoint

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

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

Operation ID

LifecycleBatchUpgrade

Permalink

Request Example

curl -X POST '{host}/api/v1/agents/lifecycle/batch-upgrade' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"agentIds":"item1,item2","toVersion":"1.5.0","artifactUrl":"https://artifacts.example.com/agent-1.5.0.tar.gz","checksum":"sha256:abc123def456","concurrency":5}'

Response Example

200
{
  "batchId": "batch-upg-001"
}

Change History

This API has no change history records yet.

View all change history