hosting
GET /v1/sites/{siteId}/directory-index
Get what a site serves when a visitor opens a folder.
احراز هویت
یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد میشود، نه 404.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/directory-index \
-H "Authorization: Bearer zdk_live_…"وارد شدهاید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی API زنده اجرا میکند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید
جزئیات
One resource over two vendor settings, because it is one idea to the customer: the ordered list of index files tried in a folder, and whether a folder with none of them lists its contents instead. `listing_enabled` is **null** when the vendor does not report it — distinct from `false`, because a switch rendered from an unknown is a switch that lies about the customer's site and invites them to turn on what may already be on. Requires `sites.view`. `404` for a site with no managed hosting package.
پارامترها
| نام | نوع | الزامی | چیست |
|---|---|---|---|
siteId (path) | Uuid | بله | Site ID (UUIDv7). |
پاسخ
| نام | نوع | الزامی | چیست |
|---|---|---|---|
files | string[] | بله | The index file names, in the order the server tries them. |
listing_enabled | boolean | بله | Whether a folder with no index file lists its contents. **Null** when the vendor does not report it — distinct from `false`, because a switch rendered from an unknown lies about… |
permitted | boolean | بله | Whether the package type includes the directory-index controls. |
خطاهایی که این نقطه پایانی میتواند برگرداند
401 · 403 · 404 · 429 · 503