Skip to main content
POST
/
v1
/
agents
/
{agentId}
/
suspend
Suspend agent
curl --request POST \
  --url https://api.ledger.so/v1/agents/{agentId}/suspend \
  --header 'Api-Key: <api-key>'
{
  "object": "agent",
  "id": "<string>",
  "status": "active",
  "previousStatus": "active"
}

Authorizations

​
Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

​
agentId
string
required

The agent ID

Response

Agent suspended

​
object
enum<string>
required
Available options:
agent
​
id
string
required
​
status
enum<string>
required
Available options:
active,
suspended
​
previousStatus
enum<string>
required
Available options:
active,
suspended