v1

latestOpenAPI 3.0.02026-07-224452146.0 KB

Monitoring

Update a monitor

patch/monitor/{monitorId}

Path parameters

monitorIdstring uuid required

The monitor ID

Request body

namestring

retentionDaysinteger

goalstring nullable

Plain-language goal used to judge whether changed pages are meaningful. If provided and judgeEnabled is omitted, judging is enabled automatically. Required (non-empty) when any target is a search target, unless judgeEnabled is false.

judgeEnabledboolean

Whether to judge changed pages against goal. Requires a non-empty goal to run.

status'active' | 'paused'

Example request

{
  "schedule": {
    "cron": "*/30 * * * *",
    "text": "every 30 minutes",
    "timezone": "UTC"
  },
  "targets": [
    {
      "scrapeOptions": {
        "actions": [
          {
            "selector": "#my-element"
          }
        ],
        "location": {
          "languages": [
            "en-US"
          ]
        },
        "threatProtection": {
          "riskScoreThreshold": 75
        }
      }
    }
  ]
}

Response

Monitor updated

successboolean

Example response

{
  "data": {
    "targets": [
      {
        "scrapeOptions": {
          "actions": [
            {
              "selector": "#my-element"
            }
          ],
          "location": {
            "languages": [
              "en-US"
            ]
          },
          "threatProtection": {
            "riskScoreThreshold": 75
          }
        }
      }
    ]
  }
}