hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Където отива идентификаторът на вашата организация
Този ендпойнт приема org_id като параметър на заявката. Оставете го празен и извикването ще обхване цялото ви поддървано дърво; изпратете го, за да ограничите извикването до една организация.
ИД на вашата организация се намира на екрана с API ключове във вашето табло за управление, до самия ключ. Това е същият ИД във всяко заявка, която правите.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X GET https://api.zinndigital.com/v1/sites/capacity \
-H "Authorization: Bearer zdk_live_…"Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
The site cap as POST /v1/sites would apply it, answered before the customer fills the form in rather than after. Until this existed the cap was reachable only by failing: the create refused with SITE_QUOTA_EXCEEDED or PLAN_REQUIRED at the end of a three-step wizard, which is the worst moment to learn a plan is full. It resolves through the same function the refusal does, so the screen and the refusal cannot disagree. It is advisory and takes no lock: another member of the organization may take the last slot between this answer and the create, in which case the create still refuses. The engine is the control; this endpoint is what lets a client disable a button with a reason instead of letting it fail. has_room is always answered — it discloses nothing a caller cannot obtain by POSTing — but every figure is gated twice: on the billing.view permission (plan size is what that permission means) and on whether the governing plan belongs to an organization already inside the caller's scope. Under hierarchical tenancy the plan may be an ancestor's and used is counted across that ancestor's whole subtree, so a client-org member is told their plan is managed elsewhere rather than handed an aggregate over sibling tenants.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
org_id (query) | Uuid | Не | The organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs. |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
has_room | boolean | Да | Whether one more site may be created right now. Always answered, at every permission level — it discloses nothing a caller cannot obtain by POSTing. Advisory: no lock is taken, so… |
unlimited | boolean | Да | Whether the grant is uncapped. When true, limit and remaining are null. |
source | string<subscription, trial, staff, none> | Да | What grants the allowance — subscription, trial, staff, or none when nothing in the organization chain grants hosting at all. |
has_plan | boolean | Да | Whether anything grants hosting. false is the PLAN_REQUIRED state the create would refuse with, reported before the customer fills the form in. |
broken_chain | boolean | Да | The organization's parent_org chain could not be walked — a data defect, not a customer without a plan. A client must say "contact support" for this, never "choose a plan", or… |
disclosed | boolean | Да | Whether the figures below are populated. False when the caller lacks billing.view, or when the governing plan belongs to an organization outside their scope. |
managed_elsewhere | boolean | Да | There IS a plan, and it is not this caller's to see — a client organization hosted under its parent's plan. The sentence to render instead of a number. |
limit | integer | Не | How many sites the plan covers. Null when undisclosed or unlimited. |
used | integer | Не | Sites already consuming the allowance, counted across the entitling organization's whole subtree. Null when undisclosed. |
remaining | integer | Не | Slots left, never negative — a downgrade to a smaller tier does not delete existing sites, so used may legitimately exceed limit. Null when undisclosed or unlimited. |
added_slots | integer | Не | Website slots bought as add-ons on the plan's line, already included in limit — so a screen can say "25 in your plan + 3 added" without adding them a second time. Null exactly… |
entitling_org_id | Uuid | Не | Which organization's plan applied — this one, or an ancestor under hierarchical tenancy. Null when undisclosed. |
breakdown | object | Не | used, split by the site status holding each slot — the answer to "what are my occupied slots actually holding?". Keys are SiteStatus values; the counts sum to used exactly.… |
Грешки, които този крайpoint може да върне
401 · 403