Axuz Developers

DELETE /api/teams/{teamId}/mail/api-keys/{keyId}

Revoga chave (soft — set revoked_at + enabled=false)

  • Access: Team admin
  • Service: https://mail-api.axuz.net

Accepted authentication

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— DELETE /api/teams/:teamId/mail/api-keys/:keyId. Soft delete: seta revoked_at=now() + enabled=false. Idempotente (WHERE revoked_at IS NULL evita segunda revogação); 404 quando não achou (id inexistente OU já revogada). Fluxo: admin do team clica "revogar"; a chave passa a rejeitar em APIKeyAuth com 403.

Parameters

NameInTypeRequiredDescription
teamIdpathstringyes
keyIdpathstringyes

Responses

200

Chave revogada

NameTypeRequiredDescription
revokedbooleanno

401

Sem credencial valida

NameTypeRequiredDescription
errorstringyes

403

Não é owner/admin

404

Chave não achada

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NameTypeRequiredDescription
errorstringyes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

curl

curl -sS -X DELETE 'https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/KEY_ID' \
  -H "Authorization: Bearer $AXUZ_TOKEN"

Node.js

const res = await fetch("https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/KEY_ID", {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "DELETE",
    "https://mail-api.axuz.net/api/teams/TEAM_ID/mail/api-keys/KEY_ID",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())