profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

Parametrično usmerjanjeTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyPisanje skript v graditelju predlogProject ScaffoldingMedijska knjižnica

Brez glave

Hitri začetekSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

Pregled REST API-jagetPovezava spletnega mesta z API-jemgetGET /routesgetGET /routegetGET /blocksgetGET /blocks/with-cel-cachegetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postPrevajanje objavepatchPATCH /translationsgetGET /usagepostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Seznam poti spletnega mesta, razdeljenih na strani, z učinkovitimi ID-ji blokov.

Prikaže seznam poti spletnega mesta, razdeljenih na strani in po potrebi filtriranih po stanju in vzorcu. Poti s praznimi block_ids se dopolnijo iz ujemajoče se dinamične privzete poti, zato so vrnjeni block_ids učinkoviti bloki za izris.

Avtorizacija: Ključ API (glava x-api-key ali parameter poizvedbe api_key).

Parametri poizvedbe

ParameterTipObveznoOpombe
websiteIduuiddaCiljno spletno mesto.
api_keynizneAlternativa glavi x-api-key.
statenizneFiltriranje po stanju poti (natančno ujemanje).
patternnizneUjemanje podniza v vzorcu poti (LIKE, pobegnjeni nadomestni znaki).
limitcelo številoneVelikost strani, privzeto 50, omejeno na 1–100.
offsetcelo številoneŠtevilo preskočenih vrstic, privzeto 0.

Rezultati so razvrščeni po updated_at DESC.

Odziv

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Kako začeti",
      "tags": [],
      "block_ids": ["..."],
      "template_block_ids": ["..."],
      "override_mode": "združi",
      "state": "V živo",
      "param_bindings": {},
      "created_at": "2026-06-23T18:34:16Z",
      "updated_at": "2026-06-23T20:36:55Z"
    }
  ],
  "total": 42,
  "hasMore": true
}

total je celotno filtrirano število; hasMore pomeni offset + limit < total. label, param_bindings, template_block_ids in override_mode so izpuščeni ali null, ko niso nastavljeni.

Primer

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

Napake

  • 400 — manjkajoč ali neveljaven websiteId
  • 401 — neveljaven ključ API (ali manjkajoč, kadar ga strežnik zahteva)
Continue Reading
Previous‹Povezava spletnega mesta z API-jemNextGET /route›