Skip to content

Códigos de Erro

Todos os erros da API devolvem uma estrutura JSON consistente:

json
{
  "success": false,
  "error": {
    "code": "SNAKE_CASE_ERROR_CODE",
    "message": "Human-readable description",
    "details": {}
  }
}

Autenticação

CódigoHTTPSignificadoCorreção
AUTH_MISSING_TOKEN401Sem cabecalho Authorization no pedidoInclua Authorization: Bearer <token> em todos os pedidos
AUTH_INVALID_TOKEN401O JWT não pode ser verificadoVerifique se o token não esta malformado ou truncado
AUTH_EXPIRED_TOKEN401O JWT expirouObtenha um novo token iniciando sessão novamente ou atualizando a sessão
AUTH_INSUFFICIENT_SCOPE403A conta autenticada não tem permissão para está açãoVerifique se está a utilizar uma conta com a função necessária

Autorização

CódigoHTTPSignificadoCorreção
TENANT_ACCESS_DENIED403Pedido tentou aceder a dados de outro tenantIsto não deveria ocorrer em utilização normal - contacte o suporte se o observar
AUTH_INSUFFICIENT_SCOPE403Permissões insuficientes para está açãoVerifique se está a utilizar uma conta com a função necessária

Tenant

CódigoHTTPSignificadoCorreção
TENANT_NOT_FOUND404Não existe conta de tenant para este utilizadorCrie uma conta em app.aether365.io
TENANT_NOT_CONNECTED400O consentimento administrativo do Microsoft 365 não foi concluídoLigue um tenant através de Definições > Ligações

Análises

CódigoHTTPSignificadoCorreção
SCAN_NOT_FOUND404O ID da análise não existe ou pertence a outro tenantVerifique o ID da análise
SCAN_ALREADY_RUNNING409Já existe uma análise em execução para este tenantAguarde que a análise atual sejá concluída
SCAN_PLAN_LIMIT_REACHED429Quota de análises esgotadaAguarde até ao próximo período de faturação ou contacte o suporte
SERVICE_UNAVAILABLE503A plataforma está em modo de manutençãoVerifique o estado e tente novamente quando a manutenção terminar

Ligações

CódigoHTTPSignificadoCorreção
CONNECTION_NOT_FOUND404O ID da ligação não existeVerifique o ID da ligação
CANNOT_REMOVE_LAST_CONNECTION409Não é possível remover a única ligação restanteAdicione outra ligação antes de remover está

Membros da Equipa

CódigoHTTPSignificadoCorreção
MEMBER_LIMIT_REACHED429Limite de membros atingidoContacte o suporte para adicionar mais membros
MEMBER_ALREADY_EXISTS409O email já tem um convite ativo ou pendenteVerifique a lista atual de membros

Análises Agendadas

CódigoHTTPSignificadoCorreção
SCAN_PLAN_LIMIT_REACHED429Limite de agendamentos personalizados atingidoElimine um agendamento existente ou contacte o suporte

Validação

CódigoHTTPSignificado
VALIDATION_ERROR400Corpo do pedido ou parâmetro de consulta inválido. O campo details lista os campos específicos inválidos.

Erros do Servidor

CódigoHTTPSignificadoCorreção
INTERNAL_ERROR500Erro inesperado do servidorTente novamente o pedido. Se o erro persistir, contacte o suporte com o ID do pedido dos cabecalhos da resposta.

Limites de Taxa

Quando excede o limite de taxa da API, a API devolve:

json
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Retry after 60 seconds."
  }
}

Estado HTTP: 429 Too Many Requests Cabecalho: Retry-After: 60

Limites de taxa atuais: 120 pedidos por minuto por chave API.

Esta página foi útil?