Sign in
Restore

Changed on
post/external-services/{id}/restore-plan

Request

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

Path parameters

idinteger required

Target service id

Request body

OR
OR

Response

Preview of what the restore will do

cross_serviceboolean required

Whether the backup was produced by a service other than the target (or its origin is unknown). A destructive cross-service restore must be confirmed explicitly with confirm_cross_service: true.

destructiveboolean required

Whether any step overwrites existing data on the target service.

enginestring required

Target engine ("postgres", etc.).

errorsstring[] required

Blocking problems. The UI disables the Start button when non-empty.

modestring required

Echo of the requested mode for the UI.

stepsstring[] required

Ordered list of human-readable actions the orchestrator will take.

strategystring required

How the restore will be performed: "walg_restore", "pg_dump_restore", "mariadb_physical_restore", "mariadb_dump_restore", or "unsupported".

warningsstring[] required

Non-blocking caveats the user should see (cross-service, empty location that will be auto-resolved, missing engine metadata, ...).

Changes

  • 2abc91dc37e1Revision changes
    • info

      added the new optional request property /

    • info

      added the required property to the response with the status

  • 4b228ebed583Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status