profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

Quick startJSON 与 Claude 代码组件 Zod 拉取

REST API

REST API 概览get连接网站 APIgetGET /routesgetGET /routegetGET /blocksget获取带有 CEL 缓存的区块getGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}get获取内容变更 SSEpatchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatch修补 CSV
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

列出网站的路由,支持分页,并包含有效的区块 ID。

列出网站的路由,支持分页,并可按状态和模式进行可选过滤。对于 block_ids 为空的路由,将从匹配的动态默认路由回填,因此返回的 block_ids 是要渲染的有效区块。

认证: API 密钥(x-api-key 请求头或 api_key 查询参数)。

查询参数

参数类型必填说明
websiteIduuid是目标网站。
api_keystring否x-api-key 请求头的替代方案。
statestring否按路由状态过滤(精确匹配)。
patternstring否对路由模式进行子串匹配(LIKE,通配符已转义)。
limitinteger否页面大小,默认 50,限定在 1–100。
offsetinteger否要跳过的行数,默认 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。当未设置时,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 密钥(或在服务器要求时缺失)
Continue Reading
Previous‹连接网站 APINextGET /route›