Skip to main content
POST
/
catchAll
/
monitors
/
{monitor_id}
/
enable
Enable monitor
curl --request POST \
  --url https://catchall.newscatcherapi.com/catchAll/monitors/{monitor_id}/enable \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "backfill": true
}
'
{
  "success": true,
  "message": "Monitor enabled successfully.",
  "monitor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Path Parameters

​
monitor_id
string<uuid>
required

Monitor identifier.

Body

application/json

Optional request body for enabling a monitor.

​
backfill
boolean
default:true

If true, fills the data gap between the last job's end_date and the first scheduled run after enabling. The last job's end_date must be within the last 7 days.

If false, no gap filling occurs and the first run uses the current cron window only — the last job's age does not matter.

Response

Monitor enabled successfully

​
success
boolean
required

True if the operation succeeded; false otherwise.

Example:

true

​
message
string
required

Human-readable success message.

Example:

"Monitor enabled successfully."

​
monitor_id
string<uuid>
required

ID of the enabled monitor.