Skip to main content

Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:
  • --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
  • --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. project-id, not --project-id).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

list

List alerts List the alerts in a project. The project is identified by the project_id path parameter alone; the x-hh-project-id header does not participate. Supports offset pagination, an optional status filter, and sorting (defaults to most recently created first).

Usage

Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

create

Create an alert Create an alert in a project. The project is identified by the project_id path parameter alone; the x-hh-project-id header does not participate. The alert’s filters and projections (metrics) are mapped against the project’s logged-event schema; if no schema data matches them — e.g. no events have been logged to the project yet — the request fails with a 400.

Usage

Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

get

Get an alert Retrieve a single alert by id, including its thresholds, triggers, and notification configuration. The alert’s project is identified by the project_id path parameter alone; the x-hh-project-id header does not participate.

Usage

Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.