LElerian
Export Jobs

Cancel an export job

Use this endpoint to cancel a queued or running export job.

post/v1/export-jobs/{jobId}/cancel

Request

Path parameters

jobIdstring required

Export Job ID

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

X-Idempotency-Keystring

Optional idempotency key for safe retries. Also accepts Idempotency-Key as an alternative header name. If the same key is sent again and the original request was already processed, the cached response is returned with X-Idempotency-Replayed: true.

See Retries and idempotency for details.

Response

Indicates that the request was successful and the response contains the expected data.

The response includes the X-Idempotency-Replayed header.

If the value is false, the request was just processed. If the value is true, the response is a replay of a previously processed request.

See Retries and idempotency for more details.

bytesWritteninteger
createdAtstring
downloadUrlstring
errorstring
expiresAtstring
fileNamestring
finishedAtstring
formatstring
idstring
recordsWritteninteger
reportTypestring
startedAtstring
statusstring

Changes

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