Skip to main content
PATCH
Update a monitor
Change a monitor. Send only the fields that change: search and webhook are merged into the stored ones, so {"search": {"max_results": 5}} keeps the query. To pause a monitor, send {"status": "paused"}. To resume it, or to turn a disabled monitor back on, send {"status": "active"}.

Authorizations

X-API-Key
string
header
required

Your API key, such as keen_.... Create one in the Keenable console. If you send both this header and Authorization, the API uses this one.

Path Parameters

id
string
required

The monitor's ID, such as mon_3kq9z2c8f1a04b7d9e6f5a21.

Body

application/json

Send only what changes.

name
string
Maximum string length: 200
status
enum<string>

paused stops matching and runs. active resumes a paused monitor and turns a disabled one back on. Activating a monitor counts toward the limit of 100 active monitors.

Available options:
active,
paused

Merged into the stored search: send only the fields that change. A new query recalibrates the monitor.

schedule
object | null

Replaces the schedule. null removes it. A new once schedule makes a completed monitor active again.

webhook
object | null

Merged into the stored webhook. Send null instead of an object to remove the webhook.

output_schema
object | null

A JSON Schema. With it, each run that finds pages also returns output: a summary of those pages in this shape, with the pages that support each field.

metadata
object | null

Your own string tags, at most 50 keys. Every webhook event carries them. For example {"team": "research"}.

Response

The updated monitor

id
string
required
Example:

"mon_3kq9z2c8f1a04b7d9e6f5a21"

object
enum<string>
required
Available options:
monitor
name
string | null
required
Example:

"Open-weights LLM releases"

status
enum<string>
required

active and paused are set by you. completed: a once monitor after its run. disabled: set by Keenable after 10 failed runs in a row, or when no webhook delivery succeeded for 3 days. Only an active monitor matches pages.

Available options:
active,
paused,
disabled,
completed
schedule
object | null
required

All three keys are always present. timezone is UTC for a cron schedule sent without one, and null for interval and once.

webhook
object | null
required
metadata
object | null
required
last_run_at
string<date-time> | null
required

When the last run ended.

next_run_at
string<date-time> | null
required

The next scheduled run. null without a schedule or while the monitor isn't active.

upcoming_runs
string<date-time>[]
required

The next three run times, in UTC. Empty without a schedule or while the monitor isn't active.

created_at
string<date-time>
required
updated_at
string<date-time>
required
output_schema
object | null
agent_run_id
string | null

Always null: not available yet.

backfill
object | null

Always null: not available yet.

memory_scope
string | null

Always null: not available yet.

estimated_cost_usd
number | null

Always null: monitors are free for now.

cost_this_month_usd
number | null

Always null: monitors are free for now.