API

Como usar a API do Vexday: chave grátis e primeira consulta de CVE

Gere a chave grátis, consulte uma CVE em JSON com a gravidade, a exploração ativa e a nota de risco, e acompanhe o limite da conta. Para levar o dado do Vexday ao seu sistema.

  • Para quemPara desenvolvedores, SOC e quem integra o Vexday a um sistema próprio.
  • PlanoConta grátis; mais volume nos planos
  • Tempocerca de 10 min

O que você precisa

  • Uma conta do Vexday: basta o e-mail, sem senha e sem cartão.
  • Um terminal com curl ou qualquer cliente HTTP.

Limites da conta: grátis, 50 por dia e 10 por minuto · SOC, 5.000 por dia e 60 por minuto · MSSP, 20.000 por dia e 120 por minuto.

Passo a passo

  1. Crie a chave

    No painel, abra Integrações e clique em Nova chave. Dê um nome, como o do sistema que vai usá-la, e copie a chave na hora: ela começa com vx_live_ e só aparece uma vez.

  2. Faça a primeira consulta

    Peça o detalhe de uma CVE com a chave no cabeçalho Authorization. O parâmetro lang escolhe o idioma dos campos traduzidos: pt, es ou en.

    curl -s -H "Authorization: Bearer vx_live_SUA_CHAVE" \
      "https://api.vexday.io/api/v1/cve/CVE-2024-3400?lang=pt"
  3. Leia a resposta

    O registro vem em data: a gravidade (cvss_score), a probabilidade de exploração (epss_score), a exploração ativa (in_kev), a prova de conceito pública (has_public_poc) e a nota de risco do Vexday (risk). O campo attribution traz o crédito das fontes: mantenha-o quando mostrar o dado.

  4. Busque o que importa para você

    A busca filtra por fabricante, produto, gravidade, exploração ativa e prova de conceito pública, e vem ordenada pelo risco. O recorte /kev traz só o que está sob exploração ativa.

    curl -s -H "Authorization: Bearer vx_live_SUA_CHAVE" \
      "https://api.vexday.io/api/v1/cve?vendor=fortinet&in_kev=true&page_size=20"
  5. Acompanhe o consumo

    O /status mostra o plano, as consultas do dia e quantas restam. O limite é da conta, somando as chaves; ao passar dele, a API responde 429 com o cabeçalho Retry-After.

    curl -s -H "Authorization: Bearer vx_live_SUA_CHAVE" "https://api.vexday.io/api/v1/status"

Deu errado?

401: chave ausente ou inválidaConfira se o cabeçalho está como Authorization: Bearer vx_live_… e se a chave não foi revogada em Integrações.
404 na consulta da CVEO ID foi escrito errado ou a CVE ainda não está na base. O formato é CVE, o ano e o número, separados por hífen.
429: limite atingidoEspere o tempo do Retry-After. Para mais volume, os planos SOC e MSSP aumentam o limite diário e o por minuto.

Perguntas frequentes

A chave é grátis mesmo?

Sim. A conta grátis já gera a chave, com um limite diário menor. Os planos pagos aumentam o volume.

Existe a especificação OpenAPI?

Sim, em https://api.vexday.io/openapi.json. A documentação interativa, para testar cada endpoint no navegador, está em https://api.vexday.io/docs.

Como sincronizo as mudanças sem baixar tudo de novo?

Pelo /changes: ele lista o que mudou desde uma data. Depois, o /cve/batch traz o detalhe de várias CVEs numa chamada.

Continue