Backups

Cancel a single in-flight backup.

Changed on

Flips the parent backups row + its latest backup_jobs row to failed with reason "cancelled by user <uid>". The in-process CancellationToken is observed on the next heartbeat tick (≤5s), so the engine exits cleanly and rollback reaps the sidecar. Idempotent: cancelling an already-terminal backup is a 200 with cancelled = 0.

post/backups/{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/{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