API

API request schemas

Field definitions from the public API contract.

Read the schema with the workflow

These fields come from the public OpenAPI contract. Required fields are marked explicitly. Type-specific and permission validation may add conditions beyond the basic field constraints. Secret placeholders in a response are not reusable credentials.

AnnIn

Field	Type	Required	Constraints / default
`title`	string	Yes	Min length: 1; Max length: 120
`body`	string	No	Default: ""; Max length: 1000
`kind`	string	No	Default: "info"

AnnPatch

Field	Type	Required	Constraints / default
`title`	string \| null	No	See operation behavior and validation.
`body`	string \| null	No	See operation behavior and validation.
`kind`	string \| null	No	See operation behavior and validation.
`resolved`	boolean \| null	No	See operation behavior and validation.

BulkIn

Field	Type	Required	Constraints / default
`ids`	array of uuid	Yes	Min items: 1; Max items: 100
`action`	string	Yes	One of: pause, resume, delete, group, update
`group`	string \| null	No	See operation behavior and validation.
`changes`	Changes \| null	No	See operation behavior and validation.

Changes

Field	Type	Required	Constraints / default
`interval`	string	No	One of: 1m, 5m, 15m, 30m, 1h, 1d; Default: "5m"
`alert_after`	integer	No	Default: 1; Minimum: 1.0; Maximum: 5.0
`alert_email`	boolean	No	Default: true
`alert_telegram`	boolean	No	Default: true
`alert_channel_ids`	array of uuid \| null	No	See operation behavior and validation.

ChannelIn

Field	Type	Required	Constraints / default
`type`	string	Yes	See operation behavior and validation.
`name`	string	Yes	Min length: 1; Max length: 60
`config`	object	Yes	See operation behavior and validation.

ChannelPatch

Field	Type	Required	Constraints / default
`enabled`	boolean	Yes	See operation behavior and validation.

CreateIn

Field	Type	Required	Constraints / default
`name`	string	Yes	See operation behavior and validation.
`monitor_id`	uuid	Yes	See operation behavior and validation.

DomainIn

Field	Type	Required	Constraints / default
`hostname`	string	Yes	See operation behavior and validation.

HTTPValidationError

Field	Type	Required	Constraints / default
`detail`	array of ValidationError	No	See operation behavior and validation.

HeaderRule

Field	Type	Required	Constraints / default
`name`	string	Yes	Min length: 1; Max length: 60
`op`	string	Yes	One of: exists, not_exists, equals, not_equals, contains, not_contains, starts_with
`value`	string \| null	No	See operation behavior and validation.

ImportIn

Field	Type	Required	Constraints / default
`csv`	string	Yes	See operation behavior and validation.

IncidentIn

Field	Type	Required	Constraints / default
`title`	string	Yes	Min length: 1; Max length: 120
`status`	string	No	One of: investigating, identified, monitoring, resolved; Default: "investigating"
`impact`	string	No	One of: none, minor, major, critical; Default: "minor"
`body`	string	No	Default: ""; Max length: 2000

IncidentPatch

Field	Type	Required	Constraints / default
`title`	string \| null	No	See operation behavior and validation.
`impact`	string \| null	No	See operation behavior and validation.

JsonRule

Field	Type	Required	Constraints / default
`path`	string	Yes	Min length: 1; Max length: 120
`op`	string	Yes	One of: equals, not_equals, contains, greater, less, exists
`value`	string \| null	No	See operation behavior and validation.

LogsSettings

Field	Type	Required	Constraints / default
`service`	string	Yes	Min length: 1; Max length: 80
`severities`	array of string	No	Max items: 6
`search`	string \| null	No	See operation behavior and validation.
`window_minutes`	integer	No	One of: 1, 5, 15, 30, 60; Default: 5
`mode`	string	No	One of: count_at_least, none_received; Default: "count_at_least"
`count`	integer	No	Default: 5; Minimum: 1.0; Maximum: 100000.0

MemberIn

Field	Type	Required	Constraints / default
`user`	string	Yes	Min length: 1; Max length: 320
`role_key`	string	Yes	See operation behavior and validation.
`monitor_id`	uuid \| null	No	See operation behavior and validation.
`monitor_ids`	array of uuid \| null	No	See operation behavior and validation.

MonitorIn

Field	Type	Required	Constraints / default
`type`	string	No	One of: website, api, ping, port, ip, ssl, dns, domain, heartbeat, logs; Default: "website"
`name`	string	Yes	Min length: 1; Max length: 80
`target`	string	Yes	Min length: 1; Max length: 2048
`interval`	string	No	One of: 1m, 5m, 15m, 30m, 1h, 1d; Default: "5m"
`port`	integer \| null	No	See operation behavior and validation.
`method`	string	No	One of: GET, POST, PUT, PATCH, DELETE, HEAD; Default: "GET"
`headers`	object	No	See operation behavior and validation.
`body`	string \| null	No	See operation behavior and validation.
`record_type`	string	No	One of: A, AAAA, CNAME, MX, NS, TXT, SOA, PTR, SRV, CAA; Default: "A"
`labels`	array of string	No	Max items: 10
`group`	string \| null	No	See operation behavior and validation.
`alert_after`	integer	No	Default: 1; Minimum: 1.0; Maximum: 5.0
`alert_channel_ids`	array of uuid \| null	No	See operation behavior and validation.
`alert_email`	boolean	No	Default: true
`alert_telegram`	boolean	No	Default: true
`quiet_start`	string \| null	No	See operation behavior and validation.
`quiet_end`	string \| null	No	See operation behavior and validation.
`quiet_tz`	string \| null	No	See operation behavior and validation.
`alert_reminder_minutes`	integer \| null	No	See operation behavior and validation.
`escalate_after_minutes`	integer \| null	No	See operation behavior and validation.
`escalate_channel_ids`	array of uuid	No	Max items: 50
`expiry_alert_days`	array of integer \| null	No	See operation behavior and validation.
`timeout_s`	integer \| null	No	See operation behavior and validation.
`retries`	integer \| null	No	See operation behavior and validation.
`ignore_tls`	boolean	No	Default: false
`status_min`	integer	No	Default: 200; Minimum: 100.0; Maximum: 599.0
`status_max`	integer	No	Default: 399; Minimum: 100.0; Maximum: 599.0
`slow_ms`	integer \| null	No	See operation behavior and validation.
`body_contains`	string \| null	No	See operation behavior and validation.
`body_not_contains`	string \| null	No	See operation behavior and validation.
`json_rules`	array of JsonRule	No	Max items: 5
`header_rules`	array of HeaderRule	No	Max items: 5
`period`	string	No	One of: 1m, 5m, 15m, 30m, 1h, 6h, 12h, 24h; Default: "5m"
`grace`	integer	No	One of: 1, 5, 15, 60; Default: 5
`warn_days`	integer \| null	No	See operation behavior and validation.
`logs`	LogsSettings \| null	No	See operation behavior and validation.
`placement`	array of Placement	No	Min items: 1; Max items: 7

MoveIn

Field	Type	Required	Constraints / default
`group`	string \| null	No	See operation behavior and validation.

NameIn

Field	Type	Required	Constraints / default
`name`	string	Yes	See operation behavior and validation.

PageIn

Field	Type	Required	Constraints / default
`slug`	string \| null	No	See operation behavior and validation.
`title`	string	Yes	Min length: 1; Max length: 80
`enabled`	boolean	No	Default: true
`monitor_ids`	array of uuid	No	Max items: 50
`logo_url`	string \| null	No	See operation behavior and validation.
`favicon_url`	string \| null	No	See operation behavior and validation.
`accent_color`	string \| null	No	See operation behavior and validation.
`header_text`	string \| null	No	See operation behavior and validation.
`footer_text`	string \| null	No	See operation behavior and validation.
`footer_link_label`	string \| null	No	See operation behavior and validation.
`footer_link_url`	string \| null	No	See operation behavior and validation.
`hide_powered_by`	boolean	No	Default: false
`theme`	string	No	Default: "system"
`homepage_url`	string \| null	No	See operation behavior and validation.

PausedIn

Field	Type	Required	Constraints / default
`paused`	boolean	Yes	See operation behavior and validation.

Placement

Field	Type	Required	Constraints / default
`region`	string	Yes	One of: auto, AF, AS, EU, NA, OC, SA
`count`	integer	Yes	Minimum: 1.0; Maximum: 5.0

RoleIn

Field	Type	Required	Constraints / default
`role_key`	string	Yes	See operation behavior and validation.

SubscribeIn

Field	Type	Required	Constraints / default
`email`	string	Yes	Max length: 254

UnlockIn

Field	Type	Required	Constraints / default
`password`	string	Yes	Max length: 128

UpdateIn

Field	Type	Required	Constraints / default
`status`	string	Yes	One of: investigating, identified, monitoring, resolved
`body`	string	No	Default: ""; Max length: 2000

ValidationError

Field	Type	Required	Constraints / default
`loc`	array of string \| integer	Yes	See operation behavior and validation.
`msg`	string	Yes	See operation behavior and validation.
`type`	string	Yes	See operation behavior and validation.
`input`	object	No	See operation behavior and validation.
`ctx`	object	No	See operation behavior and validation.

WindowIn

Field	Type	Required	Constraints / default
`title`	string	Yes	Min length: 1; Max length: 80
`starts_at`	date-time	Yes	See operation behavior and validation.
`ends_at`	date-time \| null	No	See operation behavior and validation.
`monitor_ids`	array of uuid	Yes	Min items: 1; Max items: 50
`recurrence`	string \| null	No	See operation behavior and validation.
`recurrence_days`	array of integer \| string \| null	No	See operation behavior and validation.
`recurrence_until`	date-time \| null	No	See operation behavior and validation.
`timezone`	string	No	Default: "UTC"
`duration_minutes`	integer \| null	No	See operation behavior and validation.

approutesstatus_pages__PasswordIn

Field	Type	Required	Constraints / default
`password`	string	Yes	Min length: 8; Max length: 128