Create an org export
Settings module
POST/org-exportsorgExports.create
A full organization export. Creates an org export. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability org.organization.delete.
- OAuth scopes: org.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: OrgExportCreate
| Field | Type | Required | Description |
|---|---|---|---|
| table_count | integer | Yes | Tables in the archive.Constraints: range 0 to any |
| row_count | integer (int64) | Yes | Rows across every table.Constraints: range 0 to any |
| file_count | integer | Yes | Stored files included.Constraints: range 0 to any |
| manifest_sha256 | string | Yes | SHA-256 of the archive's manifest.json, lowercase hex.Constraints: pattern ^[0-9a-f]{64}$ |
{
"table_count": 412,
"row_count": 182340,
"file_count": 96,
"manifest_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
}Response 201: OrgExport
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the org export. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| table_count | integer | Yes | Tables in the archive.Constraints: range 0 to any |
| row_count | integer (int64) | Yes | Rows across every table.Constraints: range 0 to any |
| file_count | integer | Yes | Stored files included.Constraints: range 0 to any |
| manifest_sha256 | string | Yes | SHA-256 of the archive's manifest.json, lowercase hex.Constraints: pattern ^[0-9a-f]{64}$ |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"table_count": 412,
"row_count": 182340,
"file_count": 96,
"manifest_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
}Code samples
curl -X POST "$XOS_BASE_URL/org-exports" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"table_count":412,"row_count":182340,"file_count":96,"manifest_sha256":"9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"}'const { data } = await xos.orgExports.create({
"table_count": 412,
"row_count": 182340,
"file_count": 96,
"manifest_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"
});response = xos.org_exports.create({"table_count": 412, "row_count": 182340, "file_count": 96, "manifest_sha256": "9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"})xos org-exports create --data '{"table_count":412,"row_count":182340,"file_count":96,"manifest_sha256":"9f2c4e1a7b3d5f6e8a0c2e4f6a8b0d2c4e6f8a0b2c4d6e8f0a2b4c6d8e0f2a4b"}'