Sign in
Backups

Run a backup for an external service manually.

Changed on

Enqueues the backup for asynchronous execution via the BackupRunner (ADR-014). Returns 202 Accepted immediately: pending parent and child rows are inserted, and a backup_jobs row is enqueued for the resolved engine. Poll GET /backups/{id} to observe pending → running → completed.

post/backups/external-services/{id}/run

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
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

backup_typestring nullable

Type of backup to perform (e.g., "full", "incremental")

s3_source_idinteger nullable

ID of the S3 source to store the backup. If omitted, the current default S3 source is used.

Example request

{
  "backup_type": "full",
  "s3_source_id": 1
}

Response

Backup enqueued for async execution

backup_idinteger required
backup_typestring required
checksumstring nullable
compression_typestring required
created_byinteger required
error_messagestring nullable
expires_atstring nullable
finished_atstring nullable
idinteger required
metadataunknown required
s3_locationstring required
service_idinteger required
service_name_snapshotstring nullable

Immutable provenance retained when the source service is deleted.

service_type_snapshotstring nullable
size_bytesinteger nullable
started_atstring required
statestring required

Example response

{
  "expires_at": "2025-02-15T14:30:00.123Z",
  "finished_at": "2025-01-15T14:35:00.456Z",
  "started_at": "2025-01-15T14:30:00.123Z"
}

Changes

  • 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

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status