ページネーション付きで、描画に用いる有効なブロックIDとともにウェブサイトのルートを一覧表示します。
ウェブサイトのルートを一覧表示し、ページネーションを行い、状態とパターンで任意にフィルターします。空の block_ids を持つルートは、対応する dynamic-default ルートから補完されるため、返される block_ids は描画するための有効なブロックです。
認証: APIキー(x-api-key ヘッダーまたは api_key クエリパラメータ)。
| パラメータ | 型 | 必須 | 備考 |
|---|---|---|---|
websiteId | uuid | はい | 対象のウェブサイト。 |
api_key | string | いいえ | x-api-key ヘッダーの代替。 |
state | string | いいえ | ルートの状態でフィルター(完全一致)。 |
pattern | string | いいえ | ルートパターンの部分一致(LIKE、ワイルドカードはエスケープ)。 |
limit | integer | いいえ | ページサイズ。既定は 50、1~100 に制限。 |
offset | integer | いいえ | スキップする行数。既定は 0。 |
結果は updated_at DESC で並べ替えられます。
{
"routes": [
{
"website_id": "...",
"path": "/docs/getting-started",
"pattern": "/docs/getting-started",
"label": "Getting Started",
"tags": [],
"block_ids": ["..."],
"template_block_ids": ["..."],
"override_mode": "merge",
"state": "Live",
"param_bindings": {},
"created_at": "2026-06-23T18:34:16Z",
"updated_at": "2026-06-23T20:36:55Z"
}
],
"total": 42,
"hasMore": true
}
total はフィルター後の総件数です。hasMore は offset + limit < total の場合に true となります。label、param_bindings、template_block_ids、override_mode は未設定の場合、省略されるか null になります。
curl '{CMS_API_URL}/routes?websiteId=<uuid>&limit=20' \
-H 'x-api-key: <key>'
400 — websiteId が欠落しているか無効です401 — APIキーが無効です(サーバーが必要とする場合は欠落)