Skip to main content
POST
Trigger an action on a remote agent

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organizationId
string
required

The Organization ID

deploymentId
string
required

The Deployment ID

agentId
string
required

The ID of the remote agent

Maximum string length: 250

Body

application/json
action
enum<string>
required

The action to perform on the agent. CORDON stops the agent from accepting new work; UNCORDON resumes it.

Available options:
CORDON,
UNCORDON

Response

OK

capabilities
string[]
required

The capabilities the agent supports

createdAt
string<date-time>
required

The time when the agent was created, in UTC

id
string
required

The agent's ID

isCordoned
boolean
required

Whether the agent is cordoned and not accepting new work

lastHeartbeatAt
string<date-time>
required

The time when the agent last sent a heartbeat, in UTC

name
string
required

The agent's name

queues
string[]
required

The worker queues the agent serves

slots
object
required

The agent's task execution slots

status
enum<string>
required

The current status of the agent

Available options:
HEALTHY,
UNHEALTHY,
CORDONED,
TERMINATED
version
string
required

The version of the agent

cordoningReason
string

The reason the agent is cordoned

deletedAt
string<date-time>

The time when the agent was deleted, in UTC

statusReason
string

The reason for the agent's current status