hosting
GET /v1/sites/{siteId}/ssh-keys
List a site's authorised SSH keys.
ავტორიზაცია
API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს sites.view ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.
ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.
სცადეთ
შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ssh-keys \
-H "Authorization: Bearer zdk_live_…"შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი API კონსოლში
დეტალები
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.
პარამეტრები
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
siteId (path) | Uuid | დიახ | Site ID (UUIDv7). |
პასუხი
| სახელი | ტიპი | სავალდებულო | რა არის ეს |
|---|---|---|---|
permitted | boolean | დიახ | Whether the package type includes SSH at all. This is the flag behind "your plan does not include this". |
can_create | boolean | დიახ | 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. |
keys | SiteSshKey[] | დიახ | The keys currently authorised on the package. |
ip_allowlist | string[] | დიახ | The addresses SSH is restricted to, when it is restricted. |
ip_restricted | boolean | დიახ | Whether 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 empty… |
ip_allowlist_editable | boolean | დიახ | Whether 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. |
შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს
401 · 403 · 404 · 422 · 429 · 503