hosting

GET /v1/sites/deployable-plans

The plans this organization can deploy a site into right now.

כל נקודות הקצה מסוג hosting

כל תיעוד המפתחים

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

curl -X GET https://api.zinndigital.com/v1/sites/deployable-plans \
  -H "Authorization: Bearer zdk_live_…"

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

Answers "what plan do I already have to add sites to" — one entry per plan the organization (or an ancestor, under hierarchical tenancy) already holds, with its free slots and the product lines it can actually take a site on. It exists because the create wizard opened on a flat list of every active product line with no indication which of them the customer owned or could use, so the common case — I have capacity, I want another site — was buried in a catalogue. Deploying into capacity you already own and buying more capacity are two different jobs, and this endpoint is the first of them. ⛔ Every entry resolves through the same function POST /v1/sites enforces, so a card reading "193 free" and a create answering SITE_QUOTA_EXCEEDED cannot disagree. It is advisory in exactly the way /v1/sites/capacity is: no lock is taken, so a concurrent create may still win the last slot. ⛔ Lines that no purchasable plan grants a site slot on are never returned — a managed database has no document root and a Boards plan is not hosting, so offering either as somewhere to create a website is a dead end. The set is derived from the catalogue, so a line an operator seeds tomorrow is classified correctly without a deploy. An empty data means the organization can deploy nowhere and must buy capacity first. The figures are gated exactly as /v1/sites/capacity gates them.

פרמטרים

שםסוגנדרשמה זה
org_id (query)UuidלאThe organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs.

תשובה

שםסוגנדרשמה זה
dataDeployablePlan[]כן

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403