hosting
GET /v1/sites/capacity
Whether this organization may create another site, and how much room is left.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.
Πού μπαίνει το αναγνωριστικό του οργανισμού σας
Αυτό το τελικό σημείο δέχεται την παράμετρο org_id ως παράμετρο ερωτήματος. Παραλείψτε την και η κλήση καλύπτει ολόκληρο το υποδέντρο μίσθωσής σας· στείλτε την για να περιορίσετε την κλήση σε έναν οργανισμό.
Το αναγνωριστικό του οργανισμού σας βρίσκεται στην οθόνη των κλειδιών API στον πίνακα ελέγχου σας, δίπλα στο ίδιο το κλειδί. Είναι το ίδιο αναγνωριστικό σε κάθε κλήση που πραγματοποιείτε.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
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.
Παράμετροι
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
org_id (query) | Uuid | Όχι | The organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs. |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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