hosting

GET `/v1/sites/capacity`

Whether this organization may create another site, and how much room is left.

Doğrulama

API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə sorğu parametri kimi org_id qəbul edir. Onu buraxın və sorğu bütün kirayə alt ağacınızı əhatə etsin; sorğunu bir təşkilatla məhdudlaşdırmaq üçün onu göndərin.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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.

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`org_id (query)`	`Uuid`	Xeyr	The organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs.

Cavab

Ad	Tip	Tələb olunur	Nədir
`has_room`	`boolean`	Bəli	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,…
`unlimited`	`boolean`	Bəli	Whether the grant is uncapped. When true, `limit` and `remaining` are null.
`source`	`string<subscription, trial, staff, none>`	Bəli	What grants the allowance — `subscription`, `trial`, `staff`, or `none` when nothing in the organization chain grants hosting at all.
`has_plan`	`boolean`	Bəli	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`	Bəli	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`	Bəli	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`	Bəli	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`	Xeyr	How many sites the plan covers. Null when undisclosed or unlimited.
`used`	`integer`	Xeyr	Sites already consuming the allowance, counted across the entitling organization's whole subtree. Null when undisclosed.
`remaining`	`integer`	Xeyr	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.
`entitling_org_id`	`Uuid`	Xeyr	Which organization's plan applied — this one, or an ancestor under hierarchical tenancy. Null when undisclosed.
`breakdown`	`object`	Xeyr	`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…

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403