ドキュメント本文へスキップ
API

エクスポートを開始する

ワークスペース全体の zip。バックグラウンドで作成される。

POST/exports

実際の呼び出しをワークスペースに対して実行します。

POST /exports

ワークスペース全体の zip。バックグラウンドで作成される。

例

threads:read が必要。本文は受け取らず、queued のエクスポートとともに 201 を返す。status が ready になるまで読み、その後ダウンロードする。

curl
curl -X POST "$OE/exports" -H "$AUTH"
レスポンス
{  "object": "export",  "id": "exp_8c1e4a7f2b9d3e6a0c5f1b28",  "status": "queued",  "phase": null,  "createdAt": "2026-09-30T09:12:44.000Z",  "createdBy": { "name": "Ana Lima", "email": "[email protected]" },  "startedAt": "2026-09-30T09:12:46.000Z",  "finishedAt": "2026-09-30T09:31:02.000Z",  "expiresAt": "2027-09-30T09:31:02.000Z",  "sizeBytes": 1840233472,  "fileName": "acme_20260930_093102.zip",  "threadsDone": 18420,  "threadsTotal": 18420,  "error": null}

同時に実行されるエクスポートは 1 件だけで、作成中にもう 1 件始めると 409 already_running になる。ワークスペースのエクスポートは 1 日 1 回までで、その日のうちのエクスポートは 429 export_limit_reached になる。

アプリはまず確認コードを求める。コードを 1 つ確認するまで、呼び出しは 403 step_up_required を返す。API キーが求められることはない。

リファレンス