Docs
Sandboxes ›

Get stop

GET/v1/stops/{id}

Get stop.

Requestcurl
  1. curl https://agental.io/v1/stops/sbx_2a9a47e50daec64a \
  2. -H "Authorization: Bearer $AGENTAL_API_KEY"
Answer200 OK · Stop
  1. {
  2. "id": string,
  3. "sandboxId": string,
  4. "sandboxStatus": string,
  5. "createdAt": string,
  6. }

Stop record written by POST /v1/sandboxes/{id}/stop.

Path

idrequired
string

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Returns

200 Stop record written by POST /v1/sandboxes/{id}/stop.

Stop4 fields
id
string
sandboxId
string
sandboxStatus
string
createdAt
string

Errors and other answers

404 Not found.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.