hosting

GET /v1/sites/{siteId}/subdomains

List a site's subdomains.

همه نقاط پایانی hosting

همهٔ مستندات توسعه‌دهندگان

احراز هویت

یک کلید API را به عنوان یک توکن حامل ارسال کنید. این کلید باید دارای مجوز sites.view باشد؛ کلیدی که فاقد آن باشد با خطای 403 رد می‌شود، نه 404.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/subdomains \
  -H "Authorization: Bearer zdk_live_…"

وارد شده‌اید؟ کنسول API در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر می‌کند و درخواست را روی API زنده اجرا می‌کند تا بتوانید پاسخ واقعی را ببینید. این نقطه پایانی را در کنسول API باز کنید

جزئیات

The subdomains served by the site's hosting package and the document root each one points at. ⛔ Subdomains are the only surface here with a real quantity ceiling: limit is the lower of what the package template permits and what the customer bought, so can_create is arithmetic and not merely permitted. ⚖️ On our own fleet the ceiling is the plan's max_sites, because a subdomain spends one of them (owner ruling 2026-09-01). limit is then the site cap and used carries how much of it is already spent — by the customer's sites as well as their subdomains — so a client must render the caption from used and not from data.length. On the resold line used is absent and counting the rows is correct; nothing else about the shape differs. Requires sites.view. 404 for a site with no managed hosting package and no own-fleet placement.

پارامترها

نامنوعالزامیچیست
siteId (path)UuidبلهSite ID (UUIDv7).

پاسخ

نامنوعالزامیچیست
dataSiteSubdomain[]بلهThe subdomains on the package.
limitVendorAllowanceبلهThe effective ceiling on subdomains for this site.
permittedbooleanبلهWhether the package type includes subdomains at all.
can_createbooleanبلهpermitted, and the effective ceiling has room.
usedintegerخیرHow much of limit is already spent, when that is not data.length. ⚖️ Present only on our own fleet, where a subdomain consumes one of the plan's max_sites slots (owner…

خطاهایی که این نقطه پایانی می‌تواند برگرداند

401 · 403 · 404 · 429 · 503