Stop one background command

Stop one background command

Request that a background command owned by the authenticated user in an accessible agent session stop. Returns requested: true when the stop is requested or the tracked command is already stopped or finished. This response does not confirm process exit; read the command output with GET to check its observed status.

POST/api/agent/sessions/{sessionId}/background-commands/{commandId}
Path parameters
sessionIdstringrequired
commandIdstringrequired

Request

curl
curl -X POST https://trickest.io/api/agent/sessions/{sessionId}/background-commands/{commandId} \
  -H "Authorization: Token $TRICKEST_TOKEN"

Responses

200Stop requested; read output to confirm exit
requestedbooleanrequired
400Bad Request – validation error or malformed input
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

401Unauthorized – missing or expired token
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

403Forbidden – insufficient permissions
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

429Too Many Requests – rate limited
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.

500Internal Server Error
codestringrequired
messagestringrequired
detailsobject

Field-level detail when the error is a validation failure.