Reference
Everything Beacon takes and answers, listed for looking up; Using Beacon says how to use it. The site's build checks these pages against the code: every REST operation, gateway route, error code, scope, MCP tool, command, flag and config.yaml key appears in them, or the build fails.
For agents and scripts
- REST API: getting a credential, every route with the scope it needs, the gateway's routes, and every error code.
- MCP tools: connecting, and every tool with its scope.
- Webhooks: what a hook sends: the events, the headers, the payload, the signature and the retries.
For operators
- Command line: every command and flag of
beacon,beacon-probeandbeacon-oncall. - config.yaml: every key of the service's own configuration.
- The catalogue: the catalogue, target and module files, field by field, and the checks every change passes.
How Beacon decides
- Roles, presets and scopes: what people, their agents and machines' tokens may do.
- Metrics and alert rules: every metric, and every alert rule the reference deployment ships.
- Sources: who sends Beacon what, to which route, with which token.