Sign in
Backups

Cancel every non-terminal child backup belonging to a schedule run.

Changed on

Loops over state IN ('pending','running') children and flips each via the same path as the per-backup cancel endpoint. The parent schedule_runs.finished_at is stamped automatically once no live children remain. Idempotent: cancelling a run with no live children is a 200 with cancelled = 0.

post/backups/schedule-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/backups/schedule-runs/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idinteger required

Response

Cancel processed (idempotent)

cancelledinteger required

Number of rows that were actually flipped to failed. 0 is a valid success and means the backup was already terminal — the call is idempotent.

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

  • 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