Governance
Create a tenant data export
POST /v1/organizations/{id}/data-exports · SDK createTenantDataExport · CLI deployments governance tenant-export
POST
Requires governance:write. A suspended organization can still call it.
platformBearerheader
AuthorizationBearer <token>Platform bearer credential accepted as an opaque API key or JWT.
id*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$x-deployments-organization*stringMatch
^[0-7][0-9A-HJKMNP-TV-Z]{25}$idempotency-key*stringLength
1 <= length <= 512TenantDataExportResponse
application/json- response
completedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timecreatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeerror?expiresAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeid*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$organizationId*stringMatch
^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$startedAt?stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timestatus*stringValue in
"canceled""completed""failed""pending""running"summary?updatedAt*stringMatch
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$Format
date-timeversion*integerRange
1 <= valuekind*"tenant-export"Value in
"tenant-export"output?curl -X POST "https://example.com/v1/organizations/string/data-exports" \ -H "x-deployments-organization: string" \ -H "idempotency-key: string"{ "completedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "error": { "property1": null, "property2": null }, "expiresAt": "2019-08-24T14:15:22Z", "id": "string", "organizationId": "string", "startedAt": "2019-08-24T14:15:22Z", "status": "canceled", "summary": { "property1": null, "property2": null }, "updatedAt": "2019-08-24T14:15:22Z", "version": 1, "kind": "tenant-export", "output": { "downloadUrl": "string", "downloadUrlExpiresAt": "2019-08-24T14:15:22Z", "fileName": "string", "sha256": "string", "sizeBytes": 0, "contentType": "application/x-ndjson" }}