api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Tất cả các điểm cuối api-keys

Xác thực

Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.

Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.

Dùng thử

Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.

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

Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API

Chi tiết

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

Tham số

TênLoạiBắt buộcNội dung này là gì
apiKeyId (path)UuidThe API key's id.

Phản hồi

TênLoạiBắt buộcNội dung này là gì
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_atobjectKhôngWhen the key last authenticated a request; null if never used.
revoked_atobjectKhôngAlways null on a listed/fetched key — revoked keys are not returned.
created_atstring

Các lỗi điểm cuối này có thể trả về

401 · 403 · 404 · 429