Pular para o conteúdo
Entrar Lista de espera

Revogar chave de API

DELETE /v1/api-keys/:id escopo admin

Revoga uma chave (não dá para revogar a que está fazendo a chamada).

CabeçalhosAuthorization: Bearer praeko_… e X-Praeko-Contract: en. Sempre envie os dois.

Alias antigo em português (continua respondendo, marcado como obsoleto): /v1/chaves/:id.

Parâmetros

Nome Onde Descrição
id caminho Id da chave de API (não é a chave: é o campo id).
Idempotency-Key cabeçalho Chave de idempotência (1 a 255 caracteres visíveis, por exemplo um UUID). Repetir o MESMO pedido com a mesma chave, em até 24 h, devolve a resposta guardada (com Idempotent-Replayed: true) sem executar de novo; outro pedido com a mesma chave dá 422 idempotency_key_reuse; um pedido ainda em andamento dá 409 idempotency_in_progress. Erros 5xx não são guardados. A chave vale por workspace e por rota. Veja Repetir uma requisição.

Exemplo

curl -X DELETE "https://praeko.app/v1/api-keys/01KA3Y1B9E5MK7PR3XD0V4SN2G" \
  -H "Authorization: Bearer $PRAEKO_KEY" \
  -H "X-Praeko-Contract: en"

Resposta

Status de sucesso Quando
200 Sucesso.
Resposta 200
{
  "revoked": "01KA3Y1B9E5MK7PR3XD0V4SN2G"
}

Erros

Status code Quando
404 api_key_not_found A chave não existe.
409 api_key_in_use É a chave que está fazendo esta chamada.
422 idempotency_key_reuse A Idempotency-Key já foi usada com outro pedido (método, caminho, query ou corpo diferentes).
409 idempotency_in_progress Um pedido com a mesma Idempotency-Key ainda está em andamento (repita em instantes).
409 idempotency_response_too_large A resposta original passou de 256 KB e não foi guardada; consulte o recurso por GET.

Erros de qualquer rota

Status code Quando
401 unauthorized Faltou o cabeçalho Authorization: Bearer ….
401 invalid_api_key A chave não existe.
401 revoked_api_key A chave foi revogada.
401 expired_api_key A chave expirou.
403 forbidden O escopo da chave não basta para esta rota (veja o selo de escopo).
429 rate_limited Passou do limite de requisições por minuto.

O corpo de todo erro é { "error": { "code", "message", "details"? } }. Veja todos os códigos.

Testar

Testar

O teste ao vivo usa a sua chave e a sua conta. Para quem não entrou, fica desligado.

Entre para testar
Dúvida ou erro nesta página? contato@praeko.appVer .md

Digite para buscar páginas, rotas e códigos de erro.