Skip to the page

Back up a database now

POST/v1/organisations/{id}/environments/{envId}/resources/{rid}/backup

Operation resources.backup · since 2026-11-05 · stable

Needs a session withwritescopeAnswers200 OK

{ "backup": { "name", "startedAt" } }.

Path parameters

idstring (uuid)required
The organisation id.
envIdstring (uuid)required
The environment id.
ridstringrequired
The resource id (or name, where the route accepts one).

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
  • no_backups
  • not_allowed
POST/v1/organisations/{id}/environments/{envId}/resources/{rid}/backup
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/resources/$RESOURCE_ID/backup" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN"
With the rykloud CLI
rykloud resources backup RESOURCE

Command reference: rykloud resources backup