data-exports

Cancel data_export

Cancel a pending or running data_export.

pending short-circuits straight to cancelled — no in-flight build work to interrupt. running transitions to cancelling; the worker (E-1454) picks up the signal between zip parts and the next status read will reflect the terminal state. Terminal statuses return 409 — there's no in-flight work to stop.

post/data-exports/{data_export_id}/cancel

Request

  • Base URL: https://api.cogram.com/v1
  • URL: https://api.cogram.com/v1/data-exports/{data_export_id}/cancel
  • Auth: HTTP bearer

Path parameters

data_export_idstring required

Response

Successful Response

idstring required
organization_idstring required
source'ui' | 'api' required
requester_user_idstring nullable required

ui source only.

requester_api_key_idstring nullable required

api source only.

requester_api_key_namestring nullable required

api source only. Prefer this over parsing requester_display.

requester_forwarded_userstring nullable required

X-Forwarded-User header value at create time.

requester_displaystring required

Human-readable attribution: the user's name (their email if the name is empty), API key '<name>', or <forwarded_user> (via API key '<name>'). Degrades to <forwarded_user> (via deleted API key) or unknown when the linked user or key row was deleted after the export was created.

project_idsstring[] required

Scope as requested — empty for org-wide exports. Retains ids of projects deleted after the export was created, so projects may be shorter.

project_idstring nullable required

Set only for single-project exports; null otherwise.

project_namestring nullable

Set only when project_id is set.

project_customer_idstring nullable

Customer's own project label. Not unique — use project_id for identity.

document_formatsstring[] required

Echo of the request. Typed loosely so a row written by a newer deployment, carrying a format this one does not know, still serializes instead of failing the whole listing.

status'pending' | 'running' | 'cancelling' | 'cancelled' | 'completed' | 'failed' | 'expired' required
errorstring nullable required

Set when status is failed.

requested_atstring date-time required
started_atstring date-time nullable required
completed_atstring date-time nullable required

Also set on failure and cancellation.

expires_atstring date-time nullable required

Parts are deleted at this time, 7 days after completion.

Changes

No recorded changes to this operation across all 2 revisions of this API.