List monitors - Automate.ax

axiom.listMonitors lists threshold, match-event, and anomaly monitors. Results include query configuration, cadence, thresholds, notification behavior, and notifier IDs.

automations/axiom-list-monitors.automation.ts

import { automation, onHttpRequest } from "automate.ax"
import { axiom } from "automate.ax/axiom"

export default automation("List monitors", () => {
  onHttpRequest({ scope: "automation" })
  axiom.listMonitors({})
})

Inputs

This action has no inputs.

Output

Returns an array of monitors visible through the token’s dataset access. Each item includes id, name, type, exactly one of aplQuery or mplQuery, intervalMinutes, rangeMinutes, and configured threshold, anomaly, notification, pause, notifier, and audit fields. No visible monitors returns [].

Permission and failures

The API token needs the organization-level monitors|read capability and dataset-level query|read access to each monitor’s datasets. Axiom omits monitors whose datasets the token cannot query. If this action returns [] unexpectedly, add query|read for the datasets used by those monitors. Expired or revoked tokens fail authentication.