hosting

GET `/v1/sites/capacity`

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

Autentifikimi

Drgoni një çelës API si një token mbajtës. Ky pikëndalim nuk specifikon një leje specifike në specifikim, prandaj jepini çelësit tuaj minimumin e nevojshëm dhe kontrolloni përgjigjen në vend që të supozoni.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si parametër kërkimi. Lëreni bosh dhe thirrja do të mbulojë të gjithë nëndrurin tuaj të qiramarrjes; dërgojeni atë për ta ngushtuar thirrjen në një organizatë të vetme.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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.

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`org_id (query)`	`Uuid`	Jo	The organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs.

Përgjigja

Emri	Lloji	Kërkohet	Çfarë është kjo
`has_room`	`boolean`	Po	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`	Po	Whether the grant is uncapped. When true, `limit` and `remaining` are null.
`source`	`string<subscription, trial, staff, none>`	Po	What grants the allowance — `subscription`, `trial`, `staff`, or `none` when nothing in the organization chain grants hosting at all.
`has_plan`	`boolean`	Po	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`	Po	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`	Po	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`	Po	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`	Jo	How many sites the plan covers. Null when undisclosed or unlimited.
`used`	`integer`	Jo	Sites already consuming the allowance, counted across the entitling organization's whole subtree. Null when undisclosed.
`remaining`	`integer`	Jo	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`	Jo	Which organization's plan applied — this one, or an ancestor under hierarchical tenancy. Null when undisclosed.
`breakdown`	`object`	Jo	`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…

Gabimet që ky pikëndalim mund të kthejë

401 · 403