Snapshots

Delete a snapshot

Deletes one snapshot of a report, with its file.

THERE IS NO WAY BACK. Nothing keeps a copy of the file, so the only way to have one again is taking another snapshot, which generates the report as it is today and not as it was. That is why this endpoint ALWAYS asks for a confirmation, and why its answer carries before with what the snapshot was. A link minted for it by /v1/snapshots/list stops working with a 404.

if_version is not accepted.

Refusals: 400 for the framework and the body, 403 WRITE_ACCESS_DISABLED, 404 NOT_FOUND when the snapshot is not this account's or is not there any more -- the retention of the platform prunes the oldest while a confirmation is in flight -- and 409 REPORT_IN_TRASH when the report it belongs to is in the trash, the same guard /v1/snapshots/list runs.

Every write endpoint reads dry_run and idempotency_key; see the Write guarantees section of the introduction.

post/snapshots/delete

Request

  • Base URL: https://api.reportingninja.com/v1
  • URL: https://api.reportingninja.com/v1/snapshots/delete
  • Auth: HTTP bearer

Request body

snapshot_keystring required

The snapshot to delete, from /v1/snapshots/list.

dry_runboolean

Validate everything and write nothing.

idempotency_keystring

Replays the answer of an identical call for 24 hours.

confirmation_tokenstring

The token the first call answered with, to apply the operation.

Response

The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok.

status'ok' required

Changes

No recorded changes to this operation across all 1 revision of this API.