Backups

Report what running a backup of this external service now would do — in particular whether it restarts the database — without starting it.

get/backups/external-services/{id}/run-preflight

Request

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

idinteger required

External service ID

What a backup run would do

enginestring required

Engine that would run the backup (e.g. "postgres_walg").

reasonstring nullable

Why, when restarts_database is true.

restarts_databaseboolean required

The backup restarts the database (PostgreSQL with WAL archiving off). Send confirm_restart: true to run it.

service_idinteger required

{
  "engine": "postgres_walg"
}