Skip to main content
ZStack
Recently Deleted/Recently Deleted

UpgradeManagedAgent

Upgrade the complete signed Agent package to a certified target version. Requires agent.upgrade in the stored Agent scope, an online Agent, no conflicting task and a valid upgrade precheck. Repeated requests recover the original task; query that task for completion or rollback, not just delivery of the package.

POST/api/v1/lifecycle/managed-agent/agents/{id}/upgrade

Operation ID

UpgradeManagedAgent

Since

1.3.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

Path Parameters

  • id
    StringRequired

    Unique identifier of the managed agent

Body Fields

  • requestId
    String

    Request id for this resource

    Example: value

  • precheckId
    String

    Precheck id for this resource

    Example: value

  • targetVersion
    String

    Target version for this resource

    Example: value

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • taskId
    String

    Task id for this resource

    Example: value

  • state
    String

    State for this resource

    Example: value

  • desiredAgentVersion
    String

    Desired agent version for this resource

    Example: value

  • desiredAgentRelease
    String

    Desired agent release for this resource

    Example: 10

Change History

View all change history

  • Change Time

    AddedResponse fields desiredAgentRelease
    View API