---
title: "List monitors"
method: GET
path: "/v1/monitors"
tags: ["Monitors"]
---

# List monitors

`GET /v1/monitors`

## Request

- Base URL: `https://api.ironfang.com/audit`
- URL: `https://api.ironfang.com/audit/v1/monitors`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Returns the organisation's non-archived monitors, newest first, with the site name, the pages one run may capture and the page captures the monitor may ask for over the current month. Archived monitors are omitted.

## Query parameters

- `limit` integer
- `cursor` string
- `site_id` string, uuid

## Response `200`

Monitors

- MonitorList
  - `monitors` Monitor[], required
    - `anchor_minute` integer
    - `cadence` 'manual' | 'daily' | 'six_hourly' | 'hourly', required
    - `capture_profile` CaptureProfile: Viewport and rendering settings for the monitor's evidence captures. Clamped to Ironfang Render's ceilings.
      - `color_scheme` 'light' | 'dark'
      - `device_scale_factor` number
      - `height` integer
      - `locale` string
      - `width` integer
    - `captures_per_month` integer, required: Page captures the monitor may ask audit.capture for over the current month if every run captures every page: an upper bound, not a charge. Zero unless the monitor is active and scheduled, matching the usage projection.
    - `change_policy` ChangePolicy: When a page observation counts as changed.
      - `ignore_numbers` boolean
      - `ignored_selectors` string[]
      - `min_text_change` number: Fraction of text that must differ, 0-1.
      - `min_visual_change` number: Fraction of pixels that must differ, 0-1.
      - `notify_only_on_rule_change` boolean
    - `created_at` string, date-time, required
    - `created_by` string
    - `id` string, uuid, required
    - `last_scheduled_at` string, date-time
    - `mode` 'full_site' | 'url_set', required
    - `name` string, required
    - `next_run_at` string, date-time
    - `organisation_id` string, uuid, required
    - `pages` integer, required: Pages one run may capture: the enabled URLs, or the site's page limit, within the per-audit cap.
    - `site_id` string, uuid, required
    - `site_name` string, required: The monitored site's name, resolved with the monitor rather than per row by the client.
    - `status` 'active' | 'paused' | 'archived', required
    - `timezone` string
    - `updated_at` string, date-time, required
    - `url_count` integer, required: Enabled URLs in a url_set monitor; zero for a full_site monitor.
  - `next_cursor` string: Opaque continuation boundary. Absent on the final page; no total is inferred from a page.

## Other responses

- `400`: Problem response

---

[API](https://skmtc.dev/ironfang/apis/ironfang-audit-api.md) · [All operations](https://skmtc.dev/ironfang/apis/ironfang-audit-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ironfang/apis/ironfang-audit-api/revisions/7430deff2cbd?raw)