Reten Docs
Chaves de API

Revogar Chave de API

Revogar uma chave de API ativa para desabilitá-la permanentemente.

POST /api/api-keys/:id/revoke

Revoga uma chave de API pertencente ao usuário autenticado. Uma vez revogada, a chave não pode mais ser usada para autenticação. Trata-se de uma exclusão lógica — o registro da chave é preservado para fins de auditoria.

Auth: Necessária — permissão api-key:manage

Parâmetros de Rota

ParâmetroTipoDescrição
idstringUUID da chave de API a ser revogada

Exemplo

curl -X POST https://api.reten.ai/api/api-keys/f47ac10b-58cc-4372-a567-0e02b2c3d479/revoke \
  -H "Authorization: Bearer <token>" \
  -H "x-tenant-id: <tenant-id>"
const keyId = "f47ac10b-58cc-4372-a567-0e02b2c3d479";
const response = await fetch(`https://api.reten.ai/api/api-keys/${keyId}/revoke`, {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "x-tenant-id": "<tenant-id>",
  },
});
import requests

key_id = "f47ac10b-58cc-4372-a567-0e02b2c3d479"
response = requests.post(
    f"https://api.reten.ai/api/api-keys/{key_id}/revoke",
    headers={
        "Authorization": "Bearer <token>",
        "x-tenant-id": "<tenant-id>",
    },
)

Resposta 201 Created

{
  "message": "API key revoked successfully"
}

Respostas de Erro

StatusDescrição
400A chave de API já foi revogada, ou não há contexto de tenant ativo
401Token de autenticação ausente ou inválido
403A chave de API não pertence ao usuário autenticado ou ao tenant
404Chave de API não encontrada