hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
توثيقِ شناخت
ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔
جہاں آپ کی تنظیم کی آئی ڈی آتی ہے
یہ اینڈ پوائنٹ org_id کو بطور کوئری پیرامیٹر لیتا ہے۔ اسے چھوڑ دیں اور کال آپ کے پورے ٹیننسی سب ٹری کا احاطہ کرے گی؛ کال کو کسی ایک آرگنائزیشن تک محدود کرنے کے لیے اسے بھیجیں۔
آپ کی تنظیم کی آئی ڈی آپ کے ڈیش بورڈ پر API کیز کی سکرین پر، خود کلید کے ساتھ موجود ہوتی ہے۔ یہ آپ کی کی جانے والی ہر کال میں ایک ہی آئی ڈی ہوتی ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
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