hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Onde vai o ID da sua organização
Este endpoint aceita org_id como parâmetro de consulta. Omita-o e a chamada abrangerá toda a sua subárvore de locatários; envie-o para restringir a chamada a uma única organização.
O ID da sua organização está na tela de chaves de API no seu painel, ao lado da própria chave. É o mesmo ID em todas as chamadas que você fizer.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X GET https://api.zinndigital.com/v1/sites/capacity \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
org_id (query) | Uuid | Não | The organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs. |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
has_room | boolean | Sim | 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 | Sim | Whether the grant is uncapped. When true, `limit` and `remaining` are null. |
source | string<subscription, trial, staff, none> | Sim | What grants the allowance — `subscription`, `trial`, `staff`, or `none` when nothing in the organization chain grants hosting at all. |
has_plan | boolean | Sim | 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 | Sim | 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 | Sim | 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 | Sim | 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 | Não | How many sites the plan covers. Null when undisclosed or unlimited. |
used | integer | Não | Sites already consuming the allowance, counted across the entitling organization's whole subtree. Null when undisclosed. |
remaining | integer | Não | 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 | Não | Which organization's plan applied — this one, or an ancestor under hierarchical tenancy. Null when undisclosed. |
breakdown | object | Não | `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… |
Erros que este endpoint pode retornar
401 · 403