Skip to main content
PATCH
/
agents
/
{agentId}
/
status
Update agent status
curl --request PATCH \
  --url https://api.getarbol.com/v1/agents/{agentId}/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "ACTIVE"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "status": "ACTIVE",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Use your API key from the Arbol dashboard. Go to Settings > API Keys to generate one.

Path Parameters

​
agentId
string
required

Agent ID (agt_ prefix)

Body

application/json
​
status
enum<string>
required
Available options:
ACTIVE,
PAUSED,
INACTIVE

Response

Updated agent status

​
id
string
​
name
string
​
status
enum<string>
Available options:
ACTIVE,
PAUSED,
INACTIVE
​
updatedAt
string<date-time>