Uptime Monitors Reference

Uptime Monitors are used to check publicly accessible endpoints and services from 9n9s infrastructure.

For practical examples and setup guidance, see our Uptime Monitoring guide and Getting Started guide. To configure alerting, see Setting Up Alerts.

Configuration Fields

Field	Type	Description
name	String	A human-readable name for the monitor.
protocol	Enum	The protocol to use. Can be HTTP(S) or TCP. Required.
target	String	The target to check. A URL for HTTP(S) (e.g., https://9n9s.com/api/health) or host:port for TCP (e.g., db.example.com:5432). Required.
frequency	Duration String	How often to run the check. E.g., 1m, 5m, 1h. The minimum frequency is determined by your account tier. Required.
tags	Array<String>	A list of tags to categorize and filter monitors.
check_regions	Array<String>	Planned for Q1 2024 - An array of geographic regions to run checks from (e.g., us-east-1, eu-west-1). Defaults to all available regions.
request	Object	For HTTP(S) monitors, an object to customize the request: method (GET, POST, etc.), headers (key-value pairs), and body (string).
assertions	Array<Assertion>	A list of assertions to validate the response. If any assertion fails, the check is considered “Down”. See the Assertions section below. Required.

Assertions

Assertions define the criteria for a successful check.

Type	Operator	Value Type	Description
STATUS_CODE	EQUALS, NOT_EQUALS, IN	Integer/String	Checks the HTTP status code. IN can take a range like 2xx or 4xx.
RESPONSE_TIME	LESS_THAN, GREATER_THAN	Integer (ms)	Checks the total time to get a response, in milliseconds.
RESPONSE_BODY	CONTAINS, NOT_CONTAINS, MATCHES_REGEX	String	Checks the content of the response body.
TLS_CERT_EXPIRY	MORE_THAN_DAYS	Integer	For HTTPS, checks that the SSL/TLS certificate expires in more than X days.

Statuses

An Uptime Monitor can have one of the following statuses:

Status	Description
New	The monitor has been created but has not yet run a check.
Up	The last check ran and all assertions passed.
Down	The last check ran and at least one assertion failed, or the service was unreachable.
Paused	The monitor’s checking and alerting has been manually paused.

</rewritten_file>