HTTP API
ベース URL は https://api.edge.deca-dev.com です。以下のルートはすべて /v1 で 始まり、audience が https://api.edge.deca-dev.com のベアラートークンが必要です。 作業中は、このホストだけを使ってください。詳しくは 環境とドメイン を参照してください。
対応する MCP ツールは、同じ権限チェックを伴う同じハンドラを呼びます。HTTP ルートが ないツール(関数ランタイム、データオブジェクトの履歴と付与、private データオブジェクト、 フィードバック)は MCP のページにだけ載っています。
スラッシュやドットを含むパスセグメント(コンテンツやデータオブジェクトのパス、ドメイン名)は URL エンコードします。
共通の決まり
- 組織 はトークンから決まり、パラメータで渡すことはありません。
/v1/organizations/{org_id}/workspacesの{org_id}はトークンの組織と一致する必要があり、一致しなければ 403 が返ります。このパスで別の組織を選ぶことはできません。 - ワークスペース はほとんどのルートで省略可能です。省略すると組織の
defaultワークスペースが使われます。別のワークスペースを選ぶには、クエリパラメータまたは JSON フィールドとしてworkspace_idを送ります。ログのストリームは明示的な指定が必須です。 - これらはシステムの tenant と namespace に対するコンソール上の別名です。組織とワークスペース を参照してください。
- 認証が必要なレスポンスは
Cache-Control: no-storeです。 - ページングする一覧はカーソル方式です。
認証が不要なルート
| メソッド | パス | 返すもの |
|---|---|---|
GET | /health | {"ok": true} — プラットフォームの死活確認。/v1 の配下ではありません |
GET | /v1/openapi.json | 以下のすべてのルートの OpenAPI 定義。MCP は記述しません |
GET | /v1/file-links/{token} | Webhook の download_url(送信された 1 ファイル)。ファイルが clean なら 60 秒有効なダウンロードへ 302、それまでは 409。フォームの送信内容 を参照 |
ルート一覧
ワークスペース
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/organizations/{org_id}/workspaces | namespace.read |
一覧に対応する MCP はありません。edge_namespace_get はトークンに紐づく単一のワークスペースを返します。MCP を参照してください。
ワークスペースのレコードは次の形式の配列で返ります。
[
{
"id": "0b8e4a52-31d7-4c9f-9a18-2f6c5d0b7e43",
"organization_id": "7c1f9d84-6b20-4e3a-8f57-d94a2e1b6c08",
"slug": "default",
"distribution_count": 3
}
]Distribution
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/slugs/{slug} | distribution.read |
GET | /v1/distributions | distribution.read |
POST | /v1/distributions | distribution.write |
GET | /v1/distributions/{id} | distribution.read |
PATCH | /v1/distributions/{id} | distribution.write |
POST | /v1/distributions/{id}/copy | distribution.write |
DELETE | /v1/distributions/{id} | distribution.destroy |
Deployment
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/deployments | deployment.read |
POST | /v1/distributions/{id}/deployments | deployment.write |
POST | /v1/distributions/{id}/check | deployment.write |
GET | /v1/deployments/{id} | deployment.read |
POST | /v1/deployments/{id}/commit | deployment.write |
POST | /v1/deployments/{id}/promote | deployment.promote |
GET | /v1/deployments/{from}/diff/{to} | deployment.read |
POST | /v1/distributions/{id}/rollback | deployment.promote |
GET | /v1/distributions/{id}/schedules | deployment.read |
DELETE | /v1/schedules/{id} | deployment.promote |
POST | /v1/distributions/{id}/takedown | deployment.promote |
POST | /v1/distributions/{id}/restore | deployment.promote |
GET | /v1/deployments/{id}/content | deployment.read |
PUT | /v1/deployments/{id}/content | deployment.write |
DELETE | /v1/deployments/{id}/content | deployment.write |
GET | /v1/deployments/{id}/content/{path:path} | deployment.read |
promote、takedown、restore は任意の at(タイムゾーンのオフセット付きの ISO 8601)を受け取ります。at を付けると、すぐに実行する代わりに予約を作成し、schedule_id を返します。takedown は mode(gone または redirect)と、redirect の場合は location を受け取ります。schedules は status(既定は scheduled。ほかに running、done、cancelled、failed、all)を受け取ります。リリースと公開停止を予約する を参照してください。
データオブジェクト
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/documents | document.read |
PUT | /v1/distributions/{id}/documents | document.write |
DELETE | /v1/distributions/{id}/documents | document.write |
GET | /v1/distributions/{id}/documents/{path:path} | document.read |
書き込みボディのフィールドは objects です。版履歴、切り戻し、関数への付与、private ストアは MCP のみです。MCP と データオブジェクトを配信する を参照してください。
キーバリューと SQL
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/store-grants | function.read |
PUT | /v1/distributions/{id}/store-grants | function.write |
GET | /v1/distributions/{id}/kv | function.read |
GET | /v1/distributions/{id}/kv/{key:path} | function.read |
PUT | /v1/distributions/{id}/kv/{key:path} | function.write |
DELETE | /v1/distributions/{id}/kv | function.write |
POST | /v1/distributions/{id}/sql | function.read |
PUT store-grants は store(kv または sql)、mode(none、read、read-write)、任意の scripts を受け取ります。GET kv は prefix、cursor、limit を受け取ります。PUT kv は value と、任意の ttl_seconds、if_version を受け取ります。DELETE kv は keys を受け取ります。POST sql は statements を受け取ります。読み取り専用の文は function.read、書き込む文は加えて function.write が必要です。Web コンソールではまだ管理できません。関数からキーバリューと SQL ストレージを使う を参照してください。
ドメイン
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/domains | domain.read |
POST | /v1/domains | domain.manage |
GET | /v1/domains/{fqdn} | domain.read |
POST | /v1/domains/{fqdn}/verify | domain.manage |
POST | /v1/domains/{fqdn}/attach | domain.manage |
POST | /v1/domains/{fqdn}/detach | domain.manage |
DELETE | /v1/domains/{fqdn} | domain.destroy |
チェック
| メソッド | パス | スコープ |
|---|---|---|
POST | /v1/distributions/{id}/invalidate | deployment.promote |
GET | /v1/distributions/{id}/redirect-check | distribution.read |
POST | /v1/distributions/{id}/redirects/import | distribution.write |
GET | /v1/distributions/{id}/redirects/export | distribution.read |
GET | /v1/distributions/{id}/header-check | distribution.read |
GET | /v1/distributions/{id}/health | analytics.read |
リダイレクトとヘッダーのチェックは、保存済みの設定だけを検査します。redirect-check は path(クエリ文字列を含めてよい)と任意の deployment_id を受け取ります。redirects/import は source、format(csv、netlify、json)、mode(merge または replace)、dry_run(既定は true)を受け取ります。redirects/export は format と任意の deployment_id を受け取ります。リダイレクト を参照してください。permissions-policy の値は Permissions-Policy の 2 つの文字列のいずれかです。ヘッダーの設定は deployment を作成し、その deployment を promote したあとで訪問者に届きます。
アナリティクスとログ
| メソッド | パス | スコープ |
|---|---|---|
POST | /v1/analytics | analytics.read |
POST | /v1/analytics/explore | analytics.read |
GET | /v1/analytics/realtime | analytics.read |
GET | /v1/logs | logs.read |
GET | /v1/logs/{id} | logs.read |
ゴール
| メソッド | パス | スコープ |
|---|---|---|
POST | /v1/distributions/{id}/goals/check | goals.read |
GET | /v1/distributions/{id}/goals | goals.read |
GET | /v1/distributions/{id}/goals/{goal_id} | goals.read |
POST | /v1/distributions/{id}/goals | goals.write |
PUT | /v1/distributions/{id}/goals/{slug} | goals.write |
PATCH | /v1/distributions/{id}/goals/{goal_id} | goals.write |
POST | /v1/distributions/{id}/goals/{goal_id}/archive | goals.write |
アナリティクスのグループとファネル
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/groups | funnels.read |
GET | /v1/groups/{group_id} | funnels.read |
POST | /v1/groups | funnels.write |
PATCH | /v1/groups/{group_id} | funnels.write |
POST | /v1/groups/{group_id}/funnels/check | funnels.read |
GET | /v1/groups/{group_id}/funnels | funnels.read |
GET | /v1/groups/{group_id}/funnels/{funnel_id} | funnels.read |
POST | /v1/groups/{group_id}/funnels | funnels.write |
PUT | /v1/groups/{group_id}/funnels/{slug} | funnels.write |
PATCH | /v1/groups/{group_id}/funnels/{funnel_id} | funnels.write |
POST | /v1/groups/{group_id}/funnels/{funnel_id}/archive | funnels.write |
POST | /v1/groups/{group_id}/funnels/{funnel_id}/query | funnels.read |
プロパティと PII
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/properties/check | analytics.read |
GET | /v1/distributions/{id}/properties | analytics.read |
POST | /v1/distributions/{id}/properties/{key}/declare | properties.write |
PATCH | /v1/distributions/{id}/properties/{key} | properties.write |
DELETE | /v1/distributions/{id}/properties/{key} | properties.write |
GET | /v1/distributions/{id}/pii-policy | pii.read |
PUT | /v1/distributions/{id}/pii-policy | pii.policy.write |
POST | /v1/distributions/{id}/pii-exemptions | pii.policy.write |
DELETE | /v1/distributions/{id}/pii-exemptions | pii.policy.write |
GET | /v1/pii-detectors | pii.read |
GET | /v1/distributions/{id}/pii-report | pii.read |
これらのルートの背景にあるライフサイクルとポリシーのルールは、アナリティクスプロパティを宣言する と アナリティクスプロパティを保護する を参照してください。
Webhook とフック
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/webhooks | webhook.read |
POST | /v1/webhooks | webhook.write |
GET | /v1/webhooks/{id} | webhook.read |
PATCH | /v1/webhooks/{id} | webhook.write |
DELETE | /v1/webhooks/{id} | webhook.write |
POST | /v1/webhooks/{id}/test | webhook.write |
POST | /v1/webhooks/{id}/rotate-secret | webhook.write |
GET | /v1/webhooks/{id}/deliveries | webhook.read |
POST | /v1/webhooks/{id}/deliveries/{delivery_id}/redeliver | webhook.write |
GET | /v1/distributions/{id}/hooks | hook.read |
POST | /v1/distributions/{id}/hooks | hook.write |
GET | /v1/distributions/{id}/hooks/{hook_id} | hook.read |
PATCH | /v1/distributions/{id}/hooks/{hook_id} | hook.write |
DELETE | /v1/distributions/{id}/hooks/{hook_id} | hook.write |
GET | /v1/distributions/{id}/hooks/{hook_id}/receipts | hook.read |
GET | /v1/distributions/{id}/hooks/{hook_id}/receipts/{key} | hook.read |
form.* へのサブスクリプションを作成または拡大するには、さらに form.forward と "confirm": true が必要です。distribution のホスト上の公開 URL /_hooks/{hook} はベアラートークンを受け取りません。イベント、Webhook、フック を参照してください。
エンドポイント
/_api のマップは distribution 上の runtime.api.routes にあります。データオブジェクト、バックエンドプロキシ、関数ランタイムについては エンドポイント を参照してください。
関数ランタイムは MCP のみ(edge_function_*)です。ハンドラを /_api に載せるのは wasm ルートを付けた distribution の更新(PATCH /v1/distributions/{id})です。/v1/functions ルートはありません。MCP と エンドポイントを追加する を参照してください。
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/jobs | function.read |
jobs は バックグラウンドジョブ の実行履歴を新しい順で返します。クエリパラメータは owner_kind(cron、queue、workflow、test)、owner_id、status、before(前のページの next_before)、limit(既定 50、最大 100)です。
Cron
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/crons | cron.read |
POST | /v1/distributions/{id}/crons | cron.write |
POST | /v1/distributions/{id}/crons/check | cron.read |
GET | /v1/crons/{id} | cron.read |
PATCH | /v1/crons/{id} | cron.write |
DELETE | /v1/crons/{id} | cron.write |
POST | /v1/crons/{id}/trigger | cron.write |
GET | /v1/crons/{id}/runs | cron.read |
POST …/crons は name、schedule、target と、省略可能な timezone(IANA、既定 UTC)、overlap(skip または allow)、retries(0〜3)、enabled を受け取ります。PATCH はそのいずれかを受け取ります。check は schedule、timezone、target を受け取り、何も書き込みません。trigger は次回実行を動かさずに cron を今すぐ 1 回実行します。runs は status、before、limit を受け取ります。cron の書式 を参照してください。
キュー
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/queues | queue.read |
POST | /v1/distributions/{id}/queues | queue.write |
GET | /v1/queues/{id} | queue.read |
PATCH | /v1/queues/{id} | queue.write |
DELETE | /v1/queues/{id} | queue.write |
POST | /v1/queues/{id}/messages | queue.send |
GET | /v1/queues/{id}/messages | queue.read |
POST | /v1/queues/{id}/purge | queue.write |
POST | /v1/queues/{id}/redrive | queue.write |
GET | /v1/queues/{id}/stats | queue.read |
GET | /v1/queues/{id}/runs | queue.read |
POST …/queues は name、consumer({"type": "wasm", "script_id"} または {"type": "webhook", "url"})と、省略可能な batch_size、batch_wait_seconds、concurrency、max_attempts、retention_days、paused、senders を受け取ります。Webhook コンシューマーでは応答に signing_secret が 1 回だけ含まれます。PATCH はそのいずれかを受け取ります。POST …/messages は messages として {"body", "delay_seconds"?, "idempotency_key"?} を 1〜100 件受け取ります。GET …/messages は status(ready、leased、dead)、include_bodies=true、before、limit を受け取ります。purge は status(ready または dead)と confirm: true を受け取ります。redrive は省略可能な message_ids を受け取ります。拒否された送信はコードを保ちます。queue_full と rate_limited は 429、too_large は 413 です。キューでバックグラウンド処理する を参照してください。
ワークフロー
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/workflows | workflow.read |
POST | /v1/distributions/{id}/workflows | workflow.write |
GET | /v1/workflows/{id} | workflow.read |
POST | /v1/workflows/{id}/signals | workflow.write |
POST | /v1/workflows/{id}/cancel | workflow.write |
POST | /v1/workflows/{id}/retry | workflow.write |
POST …/workflows は script_id と、省略可能な input、name、idempotency_key、retries(0〜5)を受け取ります。GET …/workflows は status、before、limit を受け取ります。signals は name と、省略可能な payload、idempotency_key を受け取ります。終わった実行へのシグナルは 409 run_finished、実行中の実行数の上限を超える開始は 429 limit_reached です。複数ステップのワークフローを作る を参照してください。
フォームの送信内容
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/submissions | submission.read |
GET | /v1/distributions/{id}/submissions/access-log | submission.read |
GET | /v1/distributions/{id}/submissions/{sid} | submission.read |
GET | /v1/distributions/{id}/submissions/{sid}/files/{upload_id} | submission.read |
GET | /v1/distributions/{id}/submissions/{sid}/files/{upload_id}/download | submission.read |
一覧は form_id、since(既定は 30 日前)、cursor を、アクセスログは since を、1 件の送信内容は任意の form_id を受け取ります。ファイルの読み取りは output(既定の text、link、content)と、テキストの場合は offset を受け取ります。download は 60 秒有効なダウンロードへ 302 を返します。読めるのはスキャンが clean のファイルだけです。パーソナルアクセストークンでの読み取りには 1 日の上限があり、distribution の送信内容用 PII ポリシーが適用されます。本人のサインインでは元の値が見えます。フォームのアップロードのポリシーは PATCH /v1/distributions/{id} の runtime.uploads です。フォームの送信内容をエージェントに読ませる を参照してください。
アクセス
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/distributions/{id}/access/rules | access.read |
POST | /v1/distributions/{id}/access/rules | access.write |
DELETE | /v1/access/rules/{id} | access.write |
POST | /v1/distributions/{id}/access/check | access.read |
GET | /v1/distributions/{id}/access/revocations | access.read |
POST | /v1/distributions/{id}/access/sessions/revoke | access.write |
GET | /v1/distributions/{id}/access/network-rules | access.read |
POST | /v1/distributions/{id}/access/network-rules | access.write |
GET | /v1/access/network-rules | access.read |
POST | /v1/access/network-rules | access.write |
DELETE | /v1/access/network-rules/{id} | access.write |
POST | /v1/distributions/{id}/access/network-check | access.read |
PUT | /v1/distributions/{id}/access/network-mode | access.write |
パスワードゲートそのものは access を付けた PATCH /v1/distributions/{id} です。アクセス制御 を参照してください。
パーソナルアクセストークン
| メソッド | パス | スコープ |
|---|---|---|
GET | /v1/tokens | サインイン済み。?all=true は token.admin が必要 |
POST | /v1/tokens | サインイン済み。パーソナルアクセストークンでは不可 |
DELETE | /v1/tokens/{id} | サインイン済み。他人のトークンは token.admin が必要 |
POST /v1/tokens は、本文に "confirm": true が無ければ何も作成しません。その場合のレスポンスは、本人に見せる確認用のサマリーです。パーソナルアクセストークンを作成する を参照してください。
個別の注意
公開中のものを削除する DELETE 系のルートは、ボディに確認用のフィールドが必要です。distribution は slug、ドメインは confirm_fqdn です。一致しない場合は 422 が返ります。
POST /v1/analytics/stream は存在しますが、上記の表には含めていません。リクエスト・レスポンス型ではなく Server-Sent Events のストリームであり、対応する MCP ツールもないためです。analytics.read が必要です。
GET /v1/logs/stream も、対応する MCP がない Server-Sent Events のストリームです。logs.read に加え、クエリパラメータ workspace_id と distribution_id の明示的な指定が必要です。ストリームは有限回のポーリングのあと閉じます。再接続は通常の動作です。