Cancel an export only while it remains queued using exports:write authority.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

export*string

Formatuuid

Header Parameters

X-Tenant-ID*string

Opaque external tenant reference.

Formatuuid

Idempotency-Key*string

Match^[A-Za-z0-9][A-Za-z0-9._:-]*$

Length16 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason*string

Length8 <= length <= 500

Response Body

`application/json`

curl -X POST "https://example.com/api/platform/v1/exports/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "X-Tenant-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: stringstringstri" \  -H "Content-Type: application/json" \  -d '{    "reason": "stringst"  }'

{  "data": {    "request": "60448f3a-8291-43df-9526-c3d4a574e4d2",    "export_class": "dashboard_extract",    "format": "csv",    "status": "queued",    "requested_at": "2019-08-24T14:15:22Z",    "ready_at": "2019-08-24T14:15:22Z",    "failed_at": "2019-08-24T14:15:22Z",    "cancelled_at": "2019-08-24T14:15:22Z",    "expired_at": "2019-08-24T14:15:22Z",    "revoked_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "artifact": {      "artifact": "d314337b-6c0d-4d0e-a3b2-d6fc0160357d",      "format": "csv",      "media_type": "string",      "bytes": 1,      "row_count": 0,      "expires_at": "2019-08-24T14:15:22Z"    }  }}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`