Pular para o conteúdo

Listar chaves

GET/tenants/{id}/api-keys

Lista as chaves do projeto, das mais novas para as mais antigas: todas as que ainda funcionam e as 100 revogadas ou expiradas mais recentes, para auditoria. Nunca devolve as chaves em si, só o prefixo e a versão mascarada. Escopo necessário: keys:read.

Ver em Markdown

Parâmetros de caminho

idstring · uuidobrigatório

Identificador do projeto (tenantId) cujas chaves você quer listar.

Respostas

Respostas: código de status, erro e descrição
CódigoErro e descrição
200apiKeys (as chaves, das mais novas para as mais antigas) e count (quantas vieram). Cada chave traz id, tenantId (o projeto), organizationId (a organização do projeto), name, prefix (identifica a chave; não é secreto), maskedKey (wag_live_<prefixo>_…, para reconhecer a chave), scopes, status (active, expired ou revoked), createdBy (apiKey:<id> da chave que a criou, user:<id> do usuário do painel ou platform), createdAt, lastUsedAt (atualizado no máximo uma vez por minuto), expiresAt, revokedAt e rotatedAt (quando uma rotação a substituiu).
400FST_ERR_VALIDATIONUm parâmetro de caminho não é um UUID; message diz qual.
401Sem chave de API, ou com uma chave inválida: desconhecida, revogada, expirada ou de um projeto desativado. O corpo é {"error": "Unauthorized"}.
403A credencial não tem o escopo keys:read; a mensagem cita o escopo (This credential lacks the keys:read scope).
404O projeto não existe ou não é de quem chama (Tenant not found): uma chave de API alcança só o próprio projeto, e o de outra pessoa responde igual a um que não existe.
429Requisições demais deste IP de origem (por padrão, 600 por minuto), ou autenticações com falha demais (por padrão, 20 a cada 5 minutos): espere os segundos de Retry-After. Veja Limites.Cabeçalho: Retry-After

Detalhes

Uma chave de API lista só as chaves do próprio projeto. No painel, qualquer membro da organização vê as chaves; só donos e administradores as criam, rotacionam e revogam.

Uma chave rotacionada aparece com rotatedAt preenchido e continua active até o expiresAt que a rotação definiu; depois disso ela passa a expired.

Guia: Autenticação

Esta página ajudou? · Atualizado em 28 set 2026