Skip to content
Dashboard
Theme
Theme

Start a full export

POST /v1/exports: Start a full export.

View Markdown

POST /v1/exports

Exports the environment (or one organization) as an ImportBundle (version 1) that POST /v1/imports reads back. The bundle never carries secrets; secrets_to_reenter lists the OIDC client secrets, SCIM tokens and SP private keys to set again after an import. A dashboard session needs a recent second factor (step_up_required). The export is ready when state is ready; GET /v1/exports/{export} then returns a signed download URL.

Scope
exports:write
Auth
Secret key (sk_…)
Since
1.0
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • organization string

    Export only this organization (default the whole environment).

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/exports" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5"
}'
Response 202
{
"id": "exp_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "export",
"organization": "example_organization",
"secrets_to_reenter": [
{
"kind": "oidc_client_secret",
"id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5"
}
],
"failure_reason": "example_failure_reason",
"created_at": "2026-01-15T09:30:00Z",
"state": "pending",
"download_url": "https://app.acme.com/callback",
"expires_at": "2026-01-15T09:30:00Z",
"bundles": [
{
"organization": "example_organization",
"state": "ready",
"size": 1,
"download_url": "https://app.acme.com/callback",
"expires_at": "2026-01-15T09:30:00Z",
"failure_reason": "example_failure_reason"
}
]
}