profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsТипове компонентиSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyСкриптове в конструктора на шаблониProject ScaffoldingМедийна библиотека

Без глава

Бърз стартSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Преглед на REST APIgetСвързване на уебсайт към CMS APIgetGET /routesgetGET /routegetGET /blocksgetВземане на блокове с CEL кешgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postПревод на публикацияpatchPATCH /translationsgetПолучаване на използванетоpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Изброява маршрутите на уебсайт, разделени на страници, с ефективни идентификатори на блокове.

Изброява маршрутите на уебсайт, разделени на страници и по избор филтрирани по състояние и шаблон. Маршрутите с празни 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": "Първи стъпки",
      "tags": [],
      "block_ids": ["..."],
      "template_block_ids": ["..."],
      "override_mode": "merge",
      "state": "Активен",
      "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‹Свързване на уебсайт към CMS APINextGET /route›