سرد مسارات موقع ويب، مع تقسيمها إلى صفحات، مع معرّفات الكتل الفعّالة.
سرد مسارات موقع ويب، مع تقسيمها إلى صفحات وبشكل اختياري تصفيتها حسب الحالة والنمط. تُستكمل المسارات التي تحتوي على block_ids فارغة من مسار dynamic-default المطابق، لذلك تكون block_ids المعادة هي الكتل الفعّالة التي سيتم عرضها.
المصادقة: مفتاح API (رأس x-api-key أو معامل الاستعلام api_key).
| المعامل | النوع | إلزامي | ملاحظات |
|---|---|---|---|
websiteId | uuid | نعم | موقع الويب الهدف. |
api_key | string | لا | بديل عن رأس x-api-key. |
state | string | لا | تصفية حسب حالة المسار (تطابق تام). |
pattern | string | لا | مطابقة جزء من السلسلة في نمط المسار (LIKE، مع تهريب أحرف البدل). |
limit | integer | لا | حجم الصفحة، القيمة الافتراضية 50، ومقيد بين 1 و100. |
offset | integer | لا | عدد الصفوف التي سيتم تخطيها، القيمة الافتراضية 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 غير صالح (أو مفقود عندما يتطلبه الخادم)