convez.ai
MCP ServerIntegração & APIsIntermediário
HailBytes

HailBytes API Documentation

HailBytes/hailbytes-api-docs

APIs REST e MCP para gerenciamento de superfície de ataque e treinamento de segurança

Ver no GitHub
InicialPluginScore · de 0 a 100

Documentação oficial e servidor MCP para HailBytes ASM (Gerenciamento de Superfície de Ataque) e SAT (Treinamento de Conscientização em Segurança). Inclui especificações OpenAPI 3.1, guias de integração e exemplos de SDK para automação de descoberta de ativos e programas de segurança.

Instalação

$npx convez-ai HailBytes/hailbytes-api-docs

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
1
Forks
0
Acompanhando
0
Saúde
50%
Último commit
há 1 semana
Versão
—
Issues abertas
3
Contribuidores
2

Casos de uso

  • Integrar descoberta contínua de ativos em plataformas SIEM e ticketing
  • Automatizar campanhas de treinamento de segurança e simulação de phishing
  • Construir workflows agenticos com Claude via MCP para análise de vulnerabilidades

Veredito

Documentação técnica sólida com especificações OpenAPI 3.1 e suporte MCP para integração programática. Adequada para equipes de segurança que precisam automatizar descoberta de ativos e treinamento de conscientização, mas requer conhecimento de APIs REST e autenticação Bearer.

README

A tradução para o português deste README ainda está na fila.

HailBytes API Documentation

Official API and MCP server documentation for HailBytes ASM (Attack Surface Management) and HailBytes SAT (Security Awareness Training).

License: MPL 2.0 OpenAPI 3.1 MCP Compatible API Docs


Overview

This repository contains the complete API reference, OpenAPI 3.1 specifications, MCP server definitions, integration guides, and SDK examples for the HailBytes platform.

  • HailBytes ASM — continuous attack surface discovery, asset inventory, and vulnerability correlation for enterprise security teams and MSSPs.
  • HailBytes SAT — automated security awareness training delivery, phishing simulation, and compliance reporting.

📖 Full documentation: hailbytes.com/docs 🔍 Interactive API reference: hailbytes.github.io/hailbytes-api-docs


Contents

PathDescription
asm/openapi.yamlOpenAPI 3.1 spec for the ASM REST API
sat/openapi.yamlOpenAPI 3.1 spec for the SAT REST API (coming soon)
mcp/MCP server definitions for ASM and SAT tool integrations (coming soon)
guides/Integration guides (SIEM, ticketing, MSSP multi-tenant) (coming soon)
sdk/SDK examples (Python, Go, TypeScript) (coming soon)
postman/Postman collections for both APIs (coming soon)

Quick Start

Authentication

All HailBytes APIs use Bearer token authentication:

Authorization: Bearer <your-api-key>

API keys are provisioned from the HailBytes dashboard.

ASM — List Assets

curl -X GET "https://api.hailbytes.com/asm/v1/assets" \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json"

SAT — Enroll a User

curl -X POST "https://api.hailbytes.com/sat/v1/users" \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "group_id": "grp_abc123"}'

MCP Server

HailBytes exposes a Model Context Protocol (MCP) server, enabling AI assistants and agentic workflows to query your attack surface, trigger scans, and manage training campaigns programmatically.

{
  "mcpServers": {
    "hailbytes": {
      "url": "https://mcp.hailbytes.com/sse",
      "headers": {
        "Authorization": "Bearer <your-api-key>"
      }
    }
  }
}

Full MCP tool definitions and usage examples are coming soon.


MSSP & Multi-Tenant

HailBytes supports MSSP deployments with tenant isolation, delegated API keys, and per-tenant reporting. A full integration guide is coming soon.


Support


License

Mozilla Public License 2.0 — see LICENSE for details.

Ver o original no GitHub

Bom para

Relacionados