hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
प्रमाणन
एक बीयर टोकन के रूप में एक API कुंजी भेजें। यह एंडपॉइंट विनिर्देश में किसी विशिष्ट अनुमति का उल्लेख नहीं करता है, इसलिए अपनी कुंजी को न्यूनतम आवश्यकता दें और अनुमान लगाने के बजाय प्रतिक्रिया की जाँच करें।
जहां आपकी संगठन आईडी आती है
यह एंडपॉइंट org_id को एक क्वेरी पैरामीटर के रूप में लेता है। इसे छोड़ दें और कॉल आपकी पूरी टेनेंसी सबट्री को कवर करेगी; कॉल को किसी एक संगठन तक सीमित करने के लिए इसे भेजें।
आपकी ऑर्गनाइजेशन आईडी आपके डैशबोर्ड पर एपीआई कीज़ स्क्रीन पर, की के ठीक बगल में मौजूद है। यह आपके द्वारा की जाने वाली हर कॉल में समान आईडी होती है।
इसे आज़माएँ
कोणार्कित ब्रैकेट्स में दी गई किसी भी चीज़ को अपने मानों से बदलें, और की प्लेसहोलर को अपने डैशबोर्ड की एक की से बदलें।
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, so… |
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. |
added_slots | integer | नहीं | Website slots bought as add-ons on the plan's line, already included in limit — so a screen can say "25 in your plan + 3 added" without adding them a second time. Null exactly… |
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