Skip to navigation
API reference

Create a private export job

Idempotent private asynchronous export. Idempotency-Key is required. A 202 acceptance or status poll is not a generated data unit. Only GET status observes generation; it never starts work.

Authentication

AuthorizationBearer

Private development credential: keyId.secret; rotate/revoke through the offline operations CLI.

Headers

Idempotency-KeystringRequiredformat: "^[A-Za-z0-9_.:-]{8,128}$"

Optional client logical-operation identifier. Scoped to principal, channel and operation class. A different canonical request conflicts; expired replay returns 410. RapidAPI retries without this stable identifier are separate attempts/operations.

Request

This endpoint expects an object.
familyenumRequired
Allowed values:
formatenumRequired
Allowed values:
filtersobjectRequired
releasestringOptionalformat: "^[a-z0-9][a-z0-9-]{0,79}$"
max_rowsintegerOptional1-5000000
max_bytesintegerOptional1024-2147483648

Response headers

X-Operation-IdstringOptionalformat: "uuid"

Durable logical operation UUID; shared by keyed retries. Not a credential.

Response

Durably accepted job; generation is asynchronous.

dataobject
metaobject or null
pageobject or null
errorobject or null

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
410
Gone Error
413
Content Too Large Error
414
URI Too Long Error
429
Too Many Requests Error
503
Service Unavailable Error