api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Всички крайни точки в api-keys

Упълномощаване

Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.

Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.

Опитайте

Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.

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

Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата

Детайли

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

Параметри

ИмеТипЗадължителноКакво представлява
apiKeyId (path)UuidДаThe API key's id.

Отговор

ИмеТипЗадължителноКакво представлява
idUuidДаUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringДа
prefixstringДаThe key's public lookup id (the middle segment of the token).
scopesstring[]ДаThe RBAC permission keys this key may exercise.
sandboxbooleanДаA 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Да

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 429