api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

모든 api-keys 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

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

무료 체험하기

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

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

로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요

상세 정보

Returns one non-revoked key's metadata (never the secret). RBAC + RLS scoped.

매개변수

이름유형필수설명
apiKeyId (path)UuidThe API key's id.

응답

이름유형필수설명
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestring
prefixstringThe key's public lookup id (the middle segment of the token).
scopesstring[]The RBAC permission keys this key may exercise.
sandboxbooleanA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobject아니요When the key last authenticated a request; null if never used.
revoked_atobject아니요Always null on a listed/fetched key — revoked keys are not returned.
created_atstring

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 429