Skip to main content
POST
/
v1
/
agents
/
{agentId}
/
commands
Trigger an Agent command
curl --request POST \
  --url https://eu1.api.matillion.com/dpc/v1/agents/{agentId}/commands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "command": "RESTART"
}
'
{
  "type": "https://api.matillion.com/problems/bad-request",
  "title": "Bad Request",
  "status": 400,
  "detail": "Failed to read request. Please check your request body.",
  "instance": "/v1/agents/{agentId}/commands"
}

Authorizations

Authorization
string
header
required

a valid bearer token

Path Parameters

agentId
string
required

Body

application/json
command
enum<string>
required

The command being sent

Available options:
RESTART,
PAUSE,
RESUME
Example:

"RESTART"

Response

Agent command received successfully