profound-logoProfound CMS
⌘K
Admin
Theme
BelgelerTutorialBlogPhilosophy
BelgelerTutorialBlogPhilosophy

Hybrid

Collection of Pages with ComponentsTypes of ComponentsSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyŞablon oluşturucuda komut dosyası yazmaProject ScaffoldingMedia Library

Headless

Hızlı BaşlangıçSplit Screen JSON Component Builder with LLMComponent Zod Pull

REST API

REST API OverviewgetConnect your websitegetGET /routesgetGET /routegetGET /blocksgetCEL önbelleği ile blokları getirgetGET /blocks/generatedgetGET /componentsgetGET /components/{name}getVeri kümesi şema adını algetGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postGönderi çevirisipatchÇeviri yamalarıgetKullanımı alpostPOST /csvpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

Bir web sitesinin rotalarını, etkin blok kimlikleriyle birlikte sayfalandırılmış şekilde listeleyin.

Bir web sitesinin rotalarını sayfalandırılmış şekilde ve isteğe bağlı olarak duruma ve desene göre filtreleyerek listeleyin. Boş block_ids değerine sahip rotalar, eşleşen dinamik varsayılan rotadan tamamlanır, bu nedenle döndürülen block_ids render edilecek etkin bloklardır.

Kimlik doğrulama: API anahtarı (x-api-key üstbilgisi veya api_key sorgu parametresi).

Sorgu parametreleri

ParametreTürGerekliNotlar
websiteIduuidevetHedef web sitesi.
api_keystringhayırx-api-key üstbilgisine alternatif.
statestringhayırRota durumuna göre filtrele (tam eşleşme).
patternstringhayırRota deseninde alt dize eşleşmesi (LIKE, joker karakterler kaçışlı).
limitintegerhayırSayfa boyutu, varsayılan 50, 1–100 aralığına sınırlandırılır.
offsetintegerhayırAtlanacak satırlar, varsayılan 0.

Sonuçlar updated_at DESC sırasına göre düzenlenir.

Yanıt

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Başlarken",
      "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, filtrelenmiş toplam sayıdır; hasMore, offset + limit < total ifadesinin sonucudur. label, param_bindings, template_block_ids ve override_mode ayarlanmadığında atlanır veya null olur.

Örnek

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

Hatalar

  • 400 — eksik veya geçersiz websiteId
  • 401 — geçersiz API anahtarı (veya sunucu gerektirdiğinde eksik)
Continue Reading
Previous‹Connect your websiteNextGET /route›