Skip to content

README.md

Latest commit

 

History

History
109 lines (73 loc) · 3.46 KB

README.md

File metadata and controls

109 lines (73 loc) · 3.46 KB
Raw

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.0/3.1 MCP Compatible API Docs

Overview

This repository contains the complete API reference, OpenAPI specifications (ASM: 3.1, SAT: 3.0), 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

Path Description
asm/openapi.yaml OpenAPI 3.1 spec for the ASM REST API
sat/openapi.yaml OpenAPI 3.0.3 spec for the SAT REST API
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 — List Campaigns

curl -X GET "https://<your-sat-host>/api/campaigns/" \
  -H "Authorization: Bearer <your-api-key>"

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.

Contributing

Before opening an issue or PR, please check CONTRIBUTING.md — in particular, search existing open issues/PRs first to avoid duplicating work already in flight.

Support

License

Mozilla Public License 2.0 — see LICENSE for details.