hosting

GET `/v1/sites/capacity`

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

Kimlik Doğrulama

Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.

Kurum kimliğinizin yazılacağı yer

Bu uç nokta, org_id parametresini bir sorgu parametresi olarak alır. Bu parametreyi dışarıda bırakırsanız çağrı tüm kiracı alt ağacınızı kapsar; çağrıyı tek bir kuruluşa daraltmak için gönderin.

Kuruluş kimliğiniz (id), kontrol panelinizdeki API anahtarları ekranında, anahtarın hemen yanında yer alır. Yaptığınız her çağrıda aynı kimlik kullanılır.

Dene

Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.

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

Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın

Ayrıntılar

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.

Parametreler

Ad	Tür	Zorunlu	Ne olduğu
`org_id (query)`	`Uuid`	Hayır	The organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs.

Yanıt

Ad	Tür	Zorunlu	Ne olduğu
`has_room`	`boolean`	Evet	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`	Evet	Whether the grant is uncapped. When true, `limit` and `remaining` are null.
`source`	`string<subscription, trial, staff, none>`	Evet	What grants the allowance — `subscription`, `trial`, `staff`, or `none` when nothing in the organization chain grants hosting at all.
`has_plan`	`boolean`	Evet	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`	Evet	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`	Evet	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`	Evet	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`	Hayır	How many sites the plan covers. Null when undisclosed or unlimited.
`used`	`integer`	Hayır	Sites already consuming the allowance, counted across the entitling organization's whole subtree. Null when undisclosed.
`remaining`	`integer`	Hayır	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`	Hayır	Which organization's plan applied — this one, or an ancestor under hierarchical tenancy. Null when undisclosed.
`breakdown`	`object`	Hayır	`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 uç noktanın dönderebileceği hatalar

401 · 403