profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchAdminipaneeli puhverserveri seadistamineCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

KiirkäivitusSplit Screen JSON Component Builder with LLMComponent Zod Pull

RESTi API

REST API OverviewgetConnect your websitegetMarsruutide hankiminegetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPOST /translationpatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

Marsruutide hankimine

Loetle veebisaidi marsruudid, lehekülgede kaupa, koos kehtivate blokki-ID-dega.

Loetle veebisaidi marsruudid, lehekülgedeks jaotatult ning soovi korral filtreeritult oleku ja mustri järgi. Marsruudid, mille block_ids väli on tühi, täidetakse vastava dünaamilise vaikemarsruudi põhjal, seega on tagastatud block_ids renderdamiseks kehtivad blokid.

Autentimine: API võti (x-api-key päiseväli või api_key päringu parameeter).

Päringuparameetrid

ParameeterTüüpNõutavMärkused
websiteIduuidjahSihtveebisait.
api_keystringeiAlternatiiv päise x-api-key kasutamiseks.
statestringeiFiltreerib marsruudi oleku järgi (täpne vaste).
patternstringeiOsalise vaste kontroll marsruudi mustri vastu (LIKE, metamärgid on ekraneeritud).
limitintegereiLehekülje suurus, vaikimisi 50, piiratud vahemikku 1–100.
offsetintegereiVahelejäetavate ridade arv, vaikimisi 0.

Tulemused sorditakse updated_at DESC järgi.

Vastus

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Alustamine",
      "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 on täielikult filtreeritud koguarv; hasMore on offset + limit < total. label, param_bindings, template_block_ids ja override_mode jäetakse välja või on null, kui neid pole määratud.

Näide

curl '{CMS_API_URL}/routes?websiteId=<uuid>&limit=20' \
  -H 'x-api-key: <key>'

Veateated

  • 400 — puuduv või vigane websiteId
  • 401 — vigane API võti (või puudub, kui server seda nõuab)
Continue Reading
Previous‹Connect your websiteNextGET /route›