Skip to the page

Restore a backup (owner, typing the name)

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

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

Needs a session withwritescopeAnswers200 OK

Owners only.

Path parameters

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

Body (JSON)

confirmstring, up to 80required
The environment's exact name.

Errors

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

POST/v1/organisations/{id}/environments/{envId}/backups/{backupId}/restore
curl -X POST "https://api.rykloud.com/v1/organisations/$ORG_ID/environments/$ENV_ID/backups/$BACKUP_ID/restore" \
  -H "Authorization: Bearer $RYKLOUD_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "confirm": "<confirm>"
}'