Skip to the page

Stop and keep its data; nothing runs or bills at the cloud

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

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

Needs a session withwritescopeAnswers200 OK

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

Its data is kept; nothing runs or bills at the cloud while it is stopped.

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}/stop
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/stop" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN"
With the rykloud CLI
rykloud envs stop [ENV] [flags]

Command reference: rykloud envs stop