Skip to main content
POST
web.monitor.edit-interactive

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by web.monitor.create-interactive or web.monitor.inventory.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
name
string

Monitor name.

Required string length: 1 - 200
tags
string[]

Up to 17 unique labels; reserved system labels cannot be supplied.

Maximum array length: 17
Required string length: 1 - 50
status
enum<string>

Pause or resume checks.

Available options:
active,
paused
target
object

Replacement target; actions repeat every check.

detection
object
interval
object

Repeating interval, without an assigned clock time.

Response

The result

name
string
required

Monitor name.

tags
string[]
required

Caller labels.

target
object
required

Watched target and options.

detection
object
required

Change detection settings.

interval
object
required

Repeating interval, without an assigned clock time.

status
enum<string>
required

Monitor state.

Available options:
active,
paused,
failed
createdAt
string

Creation time, ISO 8601.

updatedAt
string

Update time, ISO 8601.

lastRunAt
string

Last check time, ISO 8601.

lastChangeAt
string

Last change time, ISO 8601.

nextRunAt
string

Next check time, ISO 8601.

lastError
string

Neutral error category from the last check.