Skip to content

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}/workspacesnamespace.read

一覧に対応する MCP はありません。edge_namespace_get はトークンに紐づく単一のワークスペースを返します。MCP を参照してください。

ワークスペースのレコードは次の形式の配列で返ります。

json
[
  {
    "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/distributionsdistribution.read
POST/v1/distributionsdistribution.write
GET/v1/distributions/{id}distribution.read
PATCH/v1/distributions/{id}distribution.write
POST/v1/distributions/{id}/copydistribution.write
DELETE/v1/distributions/{id}distribution.destroy

Deployment ​

メソッドパススコープ
GET/v1/distributions/{id}/deploymentsdeployment.read
POST/v1/distributions/{id}/deploymentsdeployment.write
POST/v1/distributions/{id}/checkdeployment.write
GET/v1/deployments/{id}deployment.read
POST/v1/deployments/{id}/commitdeployment.write
POST/v1/deployments/{id}/promotedeployment.promote
GET/v1/deployments/{from}/diff/{to}deployment.read
POST/v1/distributions/{id}/rollbackdeployment.promote
GET/v1/distributions/{id}/schedulesdeployment.read
DELETE/v1/schedules/{id}deployment.promote
POST/v1/distributions/{id}/takedowndeployment.promote
POST/v1/distributions/{id}/restoredeployment.promote
GET/v1/deployments/{id}/contentdeployment.read
PUT/v1/deployments/{id}/contentdeployment.write
DELETE/v1/deployments/{id}/contentdeployment.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}/documentsdocument.read
PUT/v1/distributions/{id}/documentsdocument.write
DELETE/v1/distributions/{id}/documentsdocument.write
GET/v1/distributions/{id}/documents/{path:path}document.read

書き込みボディのフィールドは objects です。版履歴、切り戻し、関数への付与、private ストアは MCP のみです。MCP と データオブジェクトを配信する を参照してください。

キーバリューと SQL ​

メソッドパススコープ
GET/v1/distributions/{id}/store-grantsfunction.read
PUT/v1/distributions/{id}/store-grantsfunction.write
GET/v1/distributions/{id}/kvfunction.read
GET/v1/distributions/{id}/kv/{key:path}function.read
PUT/v1/distributions/{id}/kv/{key:path}function.write
DELETE/v1/distributions/{id}/kvfunction.write
POST/v1/distributions/{id}/sqlfunction.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/domainsdomain.read
POST/v1/domainsdomain.manage
GET/v1/domains/{fqdn}domain.read
POST/v1/domains/{fqdn}/verifydomain.manage
POST/v1/domains/{fqdn}/attachdomain.manage
POST/v1/domains/{fqdn}/detachdomain.manage
DELETE/v1/domains/{fqdn}domain.destroy

チェック ​

メソッドパススコープ
POST/v1/distributions/{id}/invalidatedeployment.promote
GET/v1/distributions/{id}/redirect-checkdistribution.read
POST/v1/distributions/{id}/redirects/importdistribution.write
GET/v1/distributions/{id}/redirects/exportdistribution.read
GET/v1/distributions/{id}/header-checkdistribution.read
GET/v1/distributions/{id}/healthanalytics.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/analyticsanalytics.read
POST/v1/analytics/exploreanalytics.read
GET/v1/analytics/realtimeanalytics.read
GET/v1/logslogs.read
GET/v1/logs/{id}logs.read

ゴール ​

メソッドパススコープ
POST/v1/distributions/{id}/goals/checkgoals.read
GET/v1/distributions/{id}/goalsgoals.read
GET/v1/distributions/{id}/goals/{goal_id}goals.read
POST/v1/distributions/{id}/goalsgoals.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}/archivegoals.write

アナリティクスのグループとファネル ​

メソッドパススコープ
GET/v1/groupsfunnels.read
GET/v1/groups/{group_id}funnels.read
POST/v1/groupsfunnels.write
PATCH/v1/groups/{group_id}funnels.write
POST/v1/groups/{group_id}/funnels/checkfunnels.read
GET/v1/groups/{group_id}/funnelsfunnels.read
GET/v1/groups/{group_id}/funnels/{funnel_id}funnels.read
POST/v1/groups/{group_id}/funnelsfunnels.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}/archivefunnels.write
POST/v1/groups/{group_id}/funnels/{funnel_id}/queryfunnels.read

プロパティと PII ​

メソッドパススコープ
GET/v1/distributions/{id}/properties/checkanalytics.read
GET/v1/distributions/{id}/propertiesanalytics.read
POST/v1/distributions/{id}/properties/{key}/declareproperties.write
PATCH/v1/distributions/{id}/properties/{key}properties.write
DELETE/v1/distributions/{id}/properties/{key}properties.write
GET/v1/distributions/{id}/pii-policypii.read
PUT/v1/distributions/{id}/pii-policypii.policy.write
POST/v1/distributions/{id}/pii-exemptionspii.policy.write
DELETE/v1/distributions/{id}/pii-exemptionspii.policy.write
GET/v1/pii-detectorspii.read
GET/v1/distributions/{id}/pii-reportpii.read

これらのルートの背景にあるライフサイクルとポリシーのルールは、アナリティクスプロパティを宣言する と アナリティクスプロパティを保護する を参照してください。

Webhook とフック ​

メソッドパススコープ
GET/v1/webhookswebhook.read
POST/v1/webhookswebhook.write
GET/v1/webhooks/{id}webhook.read
PATCH/v1/webhooks/{id}webhook.write
DELETE/v1/webhooks/{id}webhook.write
POST/v1/webhooks/{id}/testwebhook.write
POST/v1/webhooks/{id}/rotate-secretwebhook.write
GET/v1/webhooks/{id}/deliverieswebhook.read
POST/v1/webhooks/{id}/deliveries/{delivery_id}/redeliverwebhook.write
GET/v1/distributions/{id}/hookshook.read
POST/v1/distributions/{id}/hookshook.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}/receiptshook.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}/jobsfunction.read

jobs は バックグラウンドジョブ の実行履歴を新しい順で返します。クエリパラメータは owner_kind(cron、queue、workflow、test)、owner_id、status、before(前のページの next_before)、limit(既定 50、最大 100)です。

Cron ​

メソッドパススコープ
GET/v1/distributions/{id}/cronscron.read
POST/v1/distributions/{id}/cronscron.write
POST/v1/distributions/{id}/crons/checkcron.read
GET/v1/crons/{id}cron.read
PATCH/v1/crons/{id}cron.write
DELETE/v1/crons/{id}cron.write
POST/v1/crons/{id}/triggercron.write
GET/v1/crons/{id}/runscron.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}/queuesqueue.read
POST/v1/distributions/{id}/queuesqueue.write
GET/v1/queues/{id}queue.read
PATCH/v1/queues/{id}queue.write
DELETE/v1/queues/{id}queue.write
POST/v1/queues/{id}/messagesqueue.send
GET/v1/queues/{id}/messagesqueue.read
POST/v1/queues/{id}/purgequeue.write
POST/v1/queues/{id}/redrivequeue.write
GET/v1/queues/{id}/statsqueue.read
GET/v1/queues/{id}/runsqueue.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}/workflowsworkflow.read
POST/v1/distributions/{id}/workflowsworkflow.write
GET/v1/workflows/{id}workflow.read
POST/v1/workflows/{id}/signalsworkflow.write
POST/v1/workflows/{id}/cancelworkflow.write
POST/v1/workflows/{id}/retryworkflow.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}/submissionssubmission.read
GET/v1/distributions/{id}/submissions/access-logsubmission.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}/downloadsubmission.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/rulesaccess.read
POST/v1/distributions/{id}/access/rulesaccess.write
DELETE/v1/access/rules/{id}access.write
POST/v1/distributions/{id}/access/checkaccess.read
GET/v1/distributions/{id}/access/revocationsaccess.read
POST/v1/distributions/{id}/access/sessions/revokeaccess.write
GET/v1/distributions/{id}/access/network-rulesaccess.read
POST/v1/distributions/{id}/access/network-rulesaccess.write
GET/v1/access/network-rulesaccess.read
POST/v1/access/network-rulesaccess.write
DELETE/v1/access/network-rules/{id}access.write
POST/v1/distributions/{id}/access/network-checkaccess.read
PUT/v1/distributions/{id}/access/network-modeaccess.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 の明示的な指定が必要です。ストリームは有限回のポーリングのあと閉じます。再接続は通常の動作です。

あわせて読む ​