profound-logoProfound CMS
⌘K
Admin
Theme
DocsTutorialBlogPhilosophy
DocsTutorialBlogPhilosophy

Hybrid

ניתוב פרמטריסוגי רכיביםSetup server sent events (SSE) content refetchInstall Profound CMS as a proxyכתיבת סקריפטים בבונה התבניותProject Scaffoldingספריית המדיה

ללא ראש

התחלה מהירהSplit Screen JSON Component Builder with LLMComponent Zod Pull

ממשק REST

סקירת REST APIgetחיבור-אתר-ל-API-של-CMSgetGET /routesgetGET /routegetקבלת בלוקיםgetהשגת-בלוקים-עם-מטמון-CELgetGET /blocks/generatedgetקבל רכיביםgetGET /components/{name}getGET /dataset/{schema_name}getGET /content-changes (SSE)patchPATCH /dataset/{schema_name}postתרגום פוסטpatchPATCH /translationsgetGET /usagepostפוסט-CSVpatchPATCH /csv
All Systems Operational
Powered Byprofound-logo
Theme

GET /routes

רשימת מסלולי אתר אינטרנט, בפג'ינציה, עם מזהי בלוקים אפקטיביים.

צרו רשימה של מסלולי האתר עם פג'ינציה ואפשרות לסינון לפי מצב ותבנית. מסלולים שבהם block_ids ריק משלימים נתונים מהמסלול הדינמי-ברירת-המחדל התואם, כך ש-block_ids המוחזרים הם הבלוקים האפקטיביים להצגה.

אימות: מפתח API (כותרת x-api-key או פרמטר השאילתה api_key).

פרמטרי שאילתה

פרמטרסוגנדרשהערות
websiteIduuidכןאתר היעד.
api_keystringלאחלופה לכותרת x-api-key.
statestringלאסינון לפי מצב המסלול (התאמה מדויקת).
patternstringלאהתאמת תת-מחרוזת על תבנית המסלול (LIKE, עם בריחה לתווי ויילדקארד).
limitintegerלאגודל עמוד, ברירת המחדל 50, מוגבל ל-1–100.
offsetintegerלאמספר השורות לדלג עליהן, ברירת המחדל 0.

התוצאות ממוינות לפי updated_at DESC.

תגובה

{
  "routes": [
    {
      "website_id": "...",
      "path": "/docs/getting-started",
      "pattern": "/docs/getting-started",
      "label": "Getting Started",
      "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 הוא ספירת הפריטים המלאה לאחר הסינון; hasMore הוא offset + limit < total. השדות label, param_bindings, template_block_ids ו-override_mode מושמטים או מקבלים ערך null כאשר אינם מוגדרים.

דוגמה

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

שגיאות

  • 400 — websiteId חסר או לא תקין
  • 401 — מפתח API לא תקין (או חסר כאשר השרת דורש אחד)
Continue Reading
Previous‹חיבור-אתר-ל-API-של-CMSNextGET /route›