Docs
Sandboxes ›

Get deletion operation

GET/v1/deletion-operations/{id}

Get deletion operation.

Requestcurl
  1. curl https://agental.io/v1/deletion-operations/sbx_2a9a47e50daec64a \
  2. -H "Authorization: Bearer $AGENTAL_API_KEY"
Answer200 OK · OperationView
  1. {
  2. "operation": {
  3. "id": string,
  4. "type": "create" | "start" | "stop" | "delete" | "fork" | "archive" | …,
  5. "status": "pending" | "succeeded" | "failed" | "uncertain",
  6. "sandboxId": string | null,
  7. "idempotencyKey": string | null,
  8. "error": string | null,
  9. … 2 more
  10. },
  11. "sandbox": object,
  12. }

Deletion operation.

Path

idrequired
string

Headers

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

Returns

200 Deletion operation.

OperationView2 fields
operation
Operation8 fields
id
string
type
createstartstopdeleteforkarchivemove
status
pendingsucceededfaileduncertain
sandboxId
stringnull
idempotencyKey
stringnull
error
stringnull
createdAt
string
updatedAt
string
sandbox
object

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.