hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්ය අවම අවසරය ලබා දී ප්රතිචාරය පරීක්ෂා කරන්න.
ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය
මෙම අවසාන ලක්ෂ්යය (endpoint) විමසුම් පරාමිතියක් ලෙස org_id ලබා ගනී. එය ඉවත් කළ විට ඇමතීම ඔබේ මුළු කුලී උප වෘක්ෂය (tenancy subtree) ආවරණය කරයි; ඇමතීම එක් සංවිධානයකට පමණක් සීමා කිරීමට එය යවන්න.
ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්රතිස්ථාපනය කරන්න.
curl -X GET https://api.zinndigital.com/v1/sites/capacity \
-H "Authorization: Bearer zdk_live_…"පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති API කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී API වෙත ඉල්ලීම ක්රියාත්මක කරන බැවින් ඔබට සැබෑ ප්රතිචාරය දැකගත හැක. මෙම අග්රලක්ෂ්යය 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. |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
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,… |
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. |
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… |
මෙම අවසාන ලක්ෂ්යය ආපසු ලබා දිය හැකි දෝෂ
401 · 403