hosting

GET /v1/sites/{siteId}/ssh-keys

List a site's authorised SSH keys.

Minden hosting végpont

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) sites.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

Ez a végpont nem fogad el szervezeti azonosítót. Az Ön kulcsa már azonosítja azt a szervezetet, amelyhez tartozik, és a válasz is erre vonatkozik.

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/{siteId}/ssh-keys \
  -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

Every public key that can open a shell on the site's hosting package, together with whether the package restricts SSH to a list of addresses. `ssh` has been rendered as an included plan feature since the Hosting tab shipped — from a vendor flag that really is `true` on both package types we sell — with no way anywhere in the product to upload a key, so until this resource existed the entitlement was sold and read by nothing. ⛔ `ip_restricted` is its own field and must never be derived from `ip_allowlist == []`. The vendor answers "no restriction" as null, and an empty list rendered as a restriction would tell the customer they are protected when the truth is the opposite. `ip_allowlist_editable` is false today for a **vendor** reason rather than a plan one, so a client renders the list read-only instead of an editor that cannot save. A site that is not on a vendor hosting package has no such resource and returns `404`, exactly as an out-of-scope or unknown id does — never a `403`, never an existence oracle. Requires `sites.view` **and** `sites.panel_access`: the list is the access-control state of a shell on the customer's server, which is strictly more than the phpMyAdmin and file-manager access that key already names.

Paraméterek

NévTípusKötelezőMi ez
siteId (path)UuidIgenSite ID (UUIDv7).

Válasz

NévTípusKötelezőMi ez
permittedbooleanIgenWhether the package type includes SSH at all. This is the flag behind *"your plan does not include this"*.
can_createbooleanIgen`permitted`, **and** the package has room for another key. Two fields rather than one because those are different sentences, and a single flag makes the screen say the wrong one.
keysSiteSshKey[]IgenThe keys currently authorised on the package.
ip_allowliststring[]IgenThe addresses SSH is restricted to, when it is restricted.
ip_restrictedbooleanIgenWhether an address restriction is actually in force. ⛔ **Distinct from `ip_allowlist == []` and never derived from it.** The vendor answers "no restriction" as null, and an empt…
ip_allowlist_editablebooleanIgenWhether the allow-list can be written. False today for a **vendor** reason rather than a plan one, so a client renders the list read-only instead of an editor that cannot save.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 404 · 422 · 429 · 503