Skip to the page

What restoring a backup would do

GET/v1/organisations/{id}/environments/{envId}/backups/{backupId}/restore

Operation settings.restorePreview · since 2026-11-05 · stable

Needs a session withreadscopeAnswers200 OK

What restoring that backup would do.

Path parameters

idstring (uuid)required
The organisation id.
envIdstring (uuid)required
The environment id.
backupIdstringrequired
The backup, like 20261107t030000z.

Errors

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

GET/v1/organisations/{id}/environments/{envId}/backups/{backupId}/restore
curl "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/backups/$BACKUP_ID/restore" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN"