api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Todos os endpoints de api-keys

Autenticação

Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

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

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

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

Parâmetros

NomeTipoObrigatórioO que é
apiKeyId (path)UuidSimThe API key's id.

Resposta

NomeTipoObrigatórioO que é
idUuidSimUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringSim
prefixstringSimThe key's public lookup id (the middle segment of the token).
scopesstring[]SimThe RBAC permission keys this key may exercise.
sandboxbooleanSimA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNãoWhen the key last authenticated a request; null if never used.
revoked_atobjectNãoAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringSim

Erros que este endpoint pode retornar

401 · 403 · 404 · 429