Stop an agent's running session upgrade
Stops the agent’s running session upgrade before it asks any further session. Sessions it already asked keep their pending move; move any of them back with managedAgentsReplaceSessionAgentVersion. The response is the upgrade as managedAgentsGetAgentSessionUpgrade returns it; state becomes cancelled once the page in progress finishes. 409 conflict when no upgrade is running for the agent, and 404 when the agent is not one of the caller’s organization.
Authorizations
A Recursion API key, created in the console under API keys.
Headers
Optional tenant consistency check. When present, it must name the tenant bound to the API key, including when x-organization-id is default.
1Organization in which to act. Required for a tenant-scoped API key. Optional for an organization-scoped key, where it must name that same organization. The value may be an organization id or default.
1Path Parameters
Agent id (UUID) as returned by managedAgentsCreateAgent or managedAgentsListAgents.
Response
A request to move every live root session of one agent to that agent's latest version, and how far it has come.
A request to move every live root session of one agent to that agent's latest version, and how far it has come.
The agent whose sessions this upgrade moves.
The agent's latest version when the upgrade was accepted: the version every session is asked to move to.
Sessions handled so far, by outcome.
When the upgrade completed or was cancelled, or null while it runs.
Up to 50 sessions the upgrade skipped or could not ask, in the order it met them. The counts are complete; this list is a sample.
50When the upgrade was accepted.
running: sessions are still being asked to move. completed: every live root session in scope has been asked. cancelled: the upgrade was stopped; sessions it had already asked still move.
running, completed, cancelled Path of the upgrade's status resource, where managedAgentsGetAgentSessionUpgrade reads it.
Identifier of this upgrade.
User who requested the upgrade. Absent when no user made the request.