Descanto Docs
CantoAPI Reference

Operations

Read-only lookup of a control-plane operation handle.

Get an operation

GET /v1/operations/{id}

ParamInRequiredDescription
idpathyesOperation id (a UUID v4 string)
curl -sS "$BASE/operations/$OPERATION_ID" -H "$AUTH"

Response (OperationJson):

{
  "id": "5b1e...",
  "desktop_id": "d_...",
  "kind": "wake",
  "state": "succeeded",
  "result": null,
  "error": null
}
FieldTypeDescription
idstringOperation id
desktop_idstringThe desktop this operation acts on
kindstringe.g. wake, hibernate, destroy
statestringe.g. pending, running, succeeded, failed
resultanyPresent on some settled operations
errorstring | nullSet when state is failed
StatusMeaning
200The operation
400Malformed id (not a UUID)
401Missing/invalid credentials
404Operation not found, or its desktop belongs to another org

See Concepts: Operations for how operations are created (via wake/hibernate/destroy) and the ?wait=true long-poll model.

On this page