hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
प्रमाणीकरण
एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। यो इन्डपोइन्टले विशिष्ट अनुमति खुलाएको छैन, त्यसैले अनुमान गर्नुको सट्टा आफ्नो कुञ्जीलाई आवश्यक पर्ने न्यूनतम अधिकार दिनुहोस् र प्रतिक्रिया जाँच गर्नुहोस्।
तपाईंको संस्थाको आइडी राख्ने ठाउँ
यो इन्डपोइन्टले org_id लाई क्वेरी प्यारामिटरको रूपमा लिन्छ। यसलाई छुटाउनुभयो भने कलले तपाईंको सम्पूर्ण टेनेन्सी सबट्रीलाई समेट्छ; यसलाई एउटा संस्थामा मात्र सीमित गर्न पठाउनुहोस्।
तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।
प्रयास गर्नुहोस्
कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।
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. |
प्रतिक्रिया
| नाम | प्रकार | आवश्यक | यो के हो |
|---|---|---|---|
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