profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchYlläpitäjän hallintapaneelin välityspalvelimen määrittäminenCEL Scripting in Template BuilderProject ScaffoldingMedia Library

Headless

PikakäynnistysSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST-ohjelmointirajapinta

REST API OverviewgetConnect your websitegetGET /routesgetGET /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 /translationsgetKäytön hakeminenpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Listaa verkkosivuston reitit sivutettuna ja käytössä olevien lohko-ID:ien kanssa.

Listaa verkkosivuston reitit sivutettuna ja valinnaisesti tilan ja mallin mukaan suodatettuna. Reitit, joiden block_ids on tyhjä, täydennetään vastaavasta dynaamisesta oletusreitistä, joten palautetut block_ids ovat renderöitävät voimassa olevat lohkot.

Tunnistus: API-avain (x-api-key-otsake tai api_key-kyselyparametri).

Kyselyparametrit

ParametriTyyppiPakollinenHuomautukset
websiteIduuidkylläKohdeverkkosivusto.
api_keystringeiVaihtoehto x-api-key-otsakkeelle.
statestringeiSuodata reitin tilan mukaan (tarkka osuma).
patternstringeiOsittaisosuma reitin mallissa (LIKE, jokerimerkit on escapeattu).
limitintegereiSivukoko, oletus 50, rajoitettu välille 1–100.
offsetintegereiOhitettavien rivien määrä, oletus 0.

Tulokset järjestetään updated_at DESC -järjestykseen.

Vastaus

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Aloittaminen",
      "tags": [],
      "block_ids": ["..."],
      "template_block_ids": ["..."],
      "override_mode": "yhdistä",
      "state": "Julkaistu",
      "param_bindings": {},
      "created_at": "2026-06-23T18:34:16Z",
      "updated_at": "2026-06-23T20:36:55Z"
    }
  ],
  "total": 42,
  "hasMore": true
}

total on suodatettu kokonaismäärä; hasMore on tosi, kun offset + limit < total.

label, param_bindings, template_block_ids ja override_mode jätetään pois tai ovat null, jos niitä ei ole asetettu.

Esimerkki

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

Virheet

  • 400 — puuttuva tai virheellinen websiteId
  • 401 — virheellinen API-avain (tai puuttuu, jos palvelin sitä edellyttää)
Continue Reading
Previous‹Connect your websiteNextGET /route›