curl --request PATCH \
--url https://api.octen.ai/monitors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "paused"
}
'{
"code": 0,
"msg": "success",
"request_id": "req_abc123def456",
"data": {
"monitor_id": "mon_123",
"name": "shop.example.com/products/widget-pro",
"type": "page",
"page": {
"urls": [
"https://shop.example.com/products/widget-pro"
],
"output_schema": [
{
"field_name": "price",
"field_type": "number",
"field_desc": "Current price in USD"
}
]
},
"condition": "price drops more than 10%",
"schedule": {
"interval": "1h"
},
"webhook": {
"url": "https://example.com/hooks/octen"
},
"status": "paused",
"pause_reason": "user",
"last_run": {
"run_id": "run_789",
"status": "completed",
"at": "2026-11-16T14:00:07Z"
},
"last_notified_at": "2026-11-16T14:00:07Z",
"created_at": "2026-11-16T08:22:10Z",
"notifications_7d": 1
}
}{
"code": 400,
"msg": "Missing or invalid parameter",
"request_id": "req_abc123def456"
}{
"code": 401,
"msg": "Invalid API Key",
"request_id": "req_abc123def456"
}{
"code": 404,
"msg": "Monitor not found",
"request_id": "req_abc123def456"
}{
"code": 429,
"msg": "Exceeding the rate limit",
"request_id": "req_abc123def456"
}{
"code": 500,
"msg": "Internal error",
"request_id": "req_abc123def456"
}Monitor
Update Monitor API Reference
Updates a monitor, or pauses or resumes it. Send only the fields to change; type can’t be changed. An update doesn’t trigger a run.
Effect of each change
| You change | Effect |
|---|---|
topic.query | Clears the results found so far; the next run starts over. |
Other topic fields | Keeps the results found so far; the next run returns only unseen results. |
page.urls | New URLs record a baseline; removed URLs are no longer compared. |
page.output_schema, or condition on a page monitor with output_schema | The next run records a new baseline. |
condition in other cases | Applies from the next run. |
| Any other field | The baseline is kept. |
PATCH
/
monitors
/
{id}
curl --request PATCH \
--url https://api.octen.ai/monitors/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "paused"
}
'{
"code": 0,
"msg": "success",
"request_id": "req_abc123def456",
"data": {
"monitor_id": "mon_123",
"name": "shop.example.com/products/widget-pro",
"type": "page",
"page": {
"urls": [
"https://shop.example.com/products/widget-pro"
],
"output_schema": [
{
"field_name": "price",
"field_type": "number",
"field_desc": "Current price in USD"
}
]
},
"condition": "price drops more than 10%",
"schedule": {
"interval": "1h"
},
"webhook": {
"url": "https://example.com/hooks/octen"
},
"status": "paused",
"pause_reason": "user",
"last_run": {
"run_id": "run_789",
"status": "completed",
"at": "2026-11-16T14:00:07Z"
},
"last_notified_at": "2026-11-16T14:00:07Z",
"created_at": "2026-11-16T08:22:10Z",
"notifications_7d": 1
}
}{
"code": 400,
"msg": "Missing or invalid parameter",
"request_id": "req_abc123def456"
}{
"code": 401,
"msg": "Invalid API Key",
"request_id": "req_abc123def456"
}{
"code": 404,
"msg": "Monitor not found",
"request_id": "req_abc123def456"
}{
"code": 429,
"msg": "Exceeding the rate limit",
"request_id": "req_abc123def456"
}{
"code": 500,
"msg": "Internal error",
"request_id": "req_abc123def456"
}Authorizations
bearerAuthapiKeyAuth
Body
application/json
Request body for the Update Monitor API.
Was this page helpful?