Sign in
Restore

Changed on
post/restore-runs/{id}/cancel

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/restore-runs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idinteger required

Restore run id

Response

Cancellation recorded (or already recorded); the run stops at its next check and ends as cancelled

cancel_requested_atstring nullable

When cancellation was requested, if it was.

cancellableboolean required

Whether POST /restore-runs/{id}/cancel would be accepted now.

created_atstring required
error_messagestring nullable
finished_atstring nullable
idinteger required
modestring required
not_cancellable_reasonstring nullable

Why the run cannot be cancelled now; None when cancellable.

phasestring required
recovery_targetunknown
source_backup_idinteger required
source_service_idinteger required
started_atstring nullable
statusstring required
target_service_idinteger nullable
target_service_namestring nullable

Changes