hosting

GET /v1/sites/deployable-plans

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

Minden hosting végpont

Az összes fejlesztői dokumentáció

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.

A szervezet azonosítójának helye

Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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.

Paraméterek

NévTípusKötelezőMi ez
org_id (query)UuidNemThe organization to answer for. Required when the caller can create sites in more than one; otherwise defaults to theirs.

Válasz

NévTípusKötelezőMi ez
dataDeployablePlan[]Igen

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403