Revogar chave
Revoga a chave: ela para de funcionar na hora, e a próxima requisição com ela recebe 401. A chave continua na listagem, com status: revoked e revokedAt, para auditoria. Não há como desfazer: para voltar a ter acesso, crie outra chave. Escopo necessário: keys:write.
Parâmetros de caminho
idstring · uuidobrigatórioIdentificador do projeto (tenantId) da chave.
keyIdstring · uuidobrigatórioIdentificador da chave a revogar: o id que a listagem e a criação devolvem (não o prefixo).
Respostas
| Código | Erro e descrição |
|---|---|
| 200 | A chave revogada, com status: revoked e revokedAt preenchidos. 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). |
| 400 | FST_ERR_VALIDATIONUm parâmetro de caminho não é um UUID; message diz qual. |
| 401 | Sem chave de API, ou com uma chave inválida: desconhecida, revogada, expirada ou de um projeto desativado. O corpo é {"error": "Unauthorized"}. |
| 403 | A credencial não tem o escopo keys:write (This credential lacks the keys:write scope), ou a chave a revogar tem escopos que a chave que chama não tem (An API key cannot revoke a key with scopes it does not hold: …). |
| 404 | O projeto não é de quem chama (Tenant not found), ou a chave não existe nesse projeto (API key not found). A chave de outro projeto responde igual a uma que não existe. |
| 429 | Requisiçõ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
Revogar uma chave já revogada responde 200 de novo e mantém o revokedAt da primeira revogação. Uma chave expirada também pode ser revogada.
Uma chave de API só revoga chaves cujos escopos ela tem, e pode revogar a si mesma: a requisição que a revoga termina normalmente. Para trocar uma chave sem interromper nada, prefira rotacionar.
Guia: Autenticação