Skip to the page

Cancel an environment that has not started

POST/v1/organisations/{id}/environments/{envId}/cancel

Operation environments.cancel · since 2026-11-05 · stable

Needs a session withwritescopeAnswers200 OK

{ "ok": true } once the cancel is asked for. The environment's operation then runs on its own: follow it with environments.get or rykloud envs watch.

Path parameters

idstring (uuid)required
The organisation id.
envIdstring (uuid)required
The environment id.

Body

None. Send no body, or an empty JSON object.

Errors

Every error is { "error", "message", "detail"? } (Errors and references). Besides the codes any route can answer, this one refuses with:

  • wrong_state
  • busy
  • suspended
POST/v1/organisations/{id}/environments/{envId}/cancel
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/cancel" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN"
With the rykloud CLI
rykloud envs cancel [ENV] [flags]

Command reference: rykloud envs cancel