Backups

List the individual backup jobs for a single scheduler run.

Changed on

Returns each child backups row joined with its external service name and the most-recent backup_jobs engine key. Used by the schedule detail accordion to show per-job detail on row expand.

page_size defaults to 50 and is capped at 200.

get/backups/schedule-runs/{id}/jobs

Request

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

Path parameters

idinteger required

Response

Jobs for this scheduler run

backup_idinteger required

backups.id for this job.

backup_uuidstring required

backups.backup_id UUID string.

enginestring required

Engine key (e.g. "control_plane", "redis").

error_messagestring nullable

Engine-reported error message when state = "failed".

finished_atstring nullable

When this child backup finished, if known.

s3_source_idinteger required

FK to s3_sources.id — needed for the backup detail link.

service_idinteger nullable

external_services.id — NULL for the control-plane job.

service_namestring required

Name of the external service, or "control plane" for the control-plane job.

size_bytesinteger nullable

Size in bytes once completed; None while running.

started_atstring required

When this child backup started (ISO 8601 / RFC 3339).

statestring required

Current state of this child backup.

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

  • 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