hosting

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

List a site's authorised SSH keys.

모든 hosting 엔드포인트

모든 개발자 문서

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 sites.view 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

이 엔드포인트는 조직 ID를 받지 않습니다. 사용자의 키가 이미 속한 조직을 식별하며, 응답은 해당 조직으로 한정됩니다.

무료 체험하기

대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/ssh-keys \
  -H "Authorization: Bearer zdk_live_…"

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. 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)UuidSite ID (UUIDv7).

응답

이름유형필수설명
permittedbooleanWhether the package type includes SSH at all. This is the flag behind "your plan does not include this".
can_createbooleanpermitted, 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[]The keys currently authorised on the package.
ip_allowliststring[]The addresses SSH is restricted to, when it is restricted.
ip_restrictedbooleanWhether 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_editablebooleanWhether 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