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 / then returns a signed download URL.
- Scope
exports:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”
Export only this organization (default the whole environment).organizationstring
Responses
Section titled “Responses”- 202 OK Export
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 409 Codes: idempotency_key_reused and resource-specific conflicts. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"}'const response = await fetch("https://api.ohauthcat.com/v1/exports", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/exports", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "organization": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5", },)data = response.json(){ "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" } ]}