Skip to main content
POST
Request an asynchronous password-encrypted SQL ZIP

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload.

Required string length: 1 - 128

Path Parameters

project_id
string
required

Project identifier.

Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
password
string
required
write-only

Non-blank user-controlled ZIP password, at most 1024 UTF-8 bytes. Never include it in logs or command-line arguments.

Required string length: 1 - 1024

Response

The mutation was accepted for asynchronous processing.

Durable record returned for an accepted asynchronous mutation. Optional reconciliation is a current observation for queued/running work, separate from immutable terminal state. A completed reconciliation attempt alone does not mean the operation succeeded.

id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled
created_at
string<date-time>
required
updated_at
string<date-time>
required
result
object
error
object
progress
object

Current deployment dependency observation, separate from immutable operation history. Poll the same operation; mail readiness does not mean application activation.

reconciliation
object