Skip to content

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 ​

  1. REST API: getting a credential, every route with the scope it needs, the gateway's routes, and every error code.
  2. MCP tools: connecting, and every tool with its scope.
  3. Webhooks: what a hook sends: the events, the headers, the payload, the signature and the retries.

For operators ​

  1. Command line: every command and flag of beacon, beacon-probe and beacon-oncall.
  2. config.yaml: every key of the service's own configuration.
  3. The catalogue: the catalogue, target and module files, field by field, and the checks every change passes.

How Beacon decides ​

  1. Roles, presets and scopes: what people, their agents and machines' tokens may do.
  2. Metrics and alert rules: every metric, and every alert rule the reference deployment ships.
  3. Sources: who sends Beacon what, to which route, with which token.