profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrinis maršrutizavimasKomponentų tipaiSetup server sent events (SSE) content refetchAdministratoriaus skydelio tarpinio serverio nustatymasSkriptų kūrimas šablonų kūrimo priemonėjeProject ScaffoldingMedia Library

Be sąsajos

Greitasis startasSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API apžvalgagetPrijunkite svetainę prie CMS APIgetGET /routesgetGauti maršrutągetGET /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

GET /routes

Išvardykite svetainės maršrutus, suskaidytus į puslapius, su efektyviais blokų ID.

Išvardykite svetainės maršrutus, suskaidytus į puslapius ir pasirenkamai filtruojamus pagal būseną bei šabloną. Maršrutai, kurių block_ids yra tušti, užpildomi iš atitinkamo dinaminio numatytojo maršruto, todėl grąžinami block_ids yra efektyvūs blokai, kuriuos reikia atvaizduoti.

Autentifikavimas: API raktas (x-api-key antraštė arba api_key užklausos parametras).

Užklausos parametrai

ParametrasTipasPrivalomaPastabos
websiteIduuidtaipTikslinė svetainė.
api_keystringneAlternatyva x-api-key antraštei.
statestringneFiltruoti pagal maršruto būseną (tikslus atitikmuo).
patternstringneDalinis maršruto šablono atitikimas (LIKE, pakaitos simboliai pabėgti).
limitintegernePuslapio dydis, numatytoji reikšmė 50, apribotas intervale 1–100.
offsetintegernePraleidžiamų eilučių skaičius, numatytoji reikšmė 0.

Rezultatai išdėstomi pagal updated_at DESC.

Atsakymas

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Darbo pradžia",
      "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 yra visas filtruotas skaičius; hasMore yra offset + limit < total. label, param_bindings, template_block_ids ir override_mode praleidžiami arba null, kai nenustatyti.

Pavyzdys

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

Klaidos

  • 400 — trūksta arba neteisingas websiteId
  • 401 — neteisingas API raktas (arba jo nėra, kai serveris jo reikalauja)
Continue Reading
Previous‹Prijunkite svetainę prie CMS APINextGauti maršrutą›