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

UpgradeSingle

Upgrade a single agent to the specified target version

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the agent to upgrade

Body Fields

  • targetVersionStringRequired

    Target version to upgrade the agent to

    Example: 1.5.0

Responses

200 OK

On success, this API returns the following response structure.

  • agentUuidString

    UUID of the agent on the upgraded node

    Example: agent-abc123-def456

  • oldVersionString

    Version the agent was running before upgrade

    Example: 1.4.2

  • newVersionString

    Version the agent was upgraded to

    Example: 1.5.0

  • statusString

    Result status of the upgrade (success, failed)

    Example: success

  • errorString

    Error message if the upgrade failed

    Example: connection refused

Endpoint

POST/api/v1/agents/{uuid}/upgrade

/api/v1/agents/{uuid}/upgrade

Operation ID

UpgradeSingle

Permalink

Request Example

curl -X POST '{host}/api/v1/agents/{uuid}/upgrade' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"targetVersion":"1.5.0"}'

Response Example

200
{
  "agentUuid": "agent-abc123-def456",
  "oldVersion": "1.4.2",
  "newVersion": "1.5.0",
  "status": "success",
  "error": "connection refused"
}

Change History

This API has no change history records yet.

View all change history