---
title: "Read one monitor"
method: GET
path: "/monitors/{monitorId}"
tags: ["Monitors"]
---

# Read one monitor

`GET /monitors/{monitorId}`

## Request

- Base URL: `https://api.domscout.io`
- URL: `https://api.domscout.io/monitors/{monitorId}`
- Auth: API key in header `x-api-key`

A monitor belonging to another account answers 404 MONITOR_NOT_FOUND, identically to one that does not exist: any distinction would be an id oracle.

## Path parameters

- `monitorId` string, uuid, required

## Response `200`

The monitor.

- object
  - `monitor` Monitor: A monitor as the API presents it. The signing secret is never included: only creation and rotation responses carry it, and no API read returns it. The dashboard can reveal it to the account owner.
    - `id` string, uuid
    - `name` string
    - `targetUrl` string, uri
    - `captureParams` object: The capture options every run uses. Restricted to an allow-list; injectJS is not among them, so a scheduled unattended render can never carry caller-supplied JavaScript.
    - `intervalMinutes` integer
    - `status` 'active' | 'paused'
    - `checks` object
      - `markdown` boolean
      - `links` boolean
      - `title` boolean
      - `statusCode` boolean
      - `dom` boolean
    - `domIgnoreSelectors` string[]
    - `domIgnoreAttributes` string[]
    - `domIgnoreTextPatterns` string[]: Checked for catastrophic backtracking at save time, because the worker applies them under a CPU budget on every run.
    - `domPositionTolerancePx` integer
    - `notifyWebhookUrl` string, uri, nullable
    - `lastRunAt` string, date-time, nullable
    - `lastRunStatus` string, nullable
    - `nextRunAt` string, date-time, nullable
    - `consecutiveErrors` integer
    - `createdAt` string, date-time
    - `updatedAt` string, date-time, nullable

## Other responses

- `404`: Not found.
- `503`: A dependency this request needs is unavailable or not configured for this deployment. Codes: SUPABASE_TIMEOUT and SUPABASE_INVALID_RESPONSE (a storage operation did not answer, or answered unreadably — the write may have committed, so any retry must be idempotent), CAPTURE_ARTIFACT_UNAVAILABLE and CAPTURE_ARTIFACT_CORRUPT (a stored artifact could not be read or parsed), ASYNC_JOBS_NOT_CONFIGURED and CAPTURE_RETRIEVAL_NOT_CONFIGURED (the capability is not configured here, on any plan). Retryable unless the code names a deployment configuration.

---

[API](https://skmtc.dev/domscout/apis/domscout-api.md) · [All operations](https://skmtc.dev/domscout/apis/domscout-api/llms.txt) · [OpenAPI document](https://skmtc.dev/domscout/apis/domscout-api/revisions/20562d5b5d94?raw)
