Skip to navigation
API reference

Preview a private export

Bounded estimate from immutable prepared counts. Encoded bytes are measured by generation, not guessed. Defaults: 250000 rows and 256MiB across the entire job; larger operator limits require explicit configuration.

Authentication

AuthorizationBearer

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

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

Private export control result.
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