POST
/
uptime
/
monitors
Please be aware that the Phare API is currently in beta and is subject to change.

Authorizations

Authorization
string
headerrequired

Use a user token to access authenticated routes. The token must be specified in the Authorization HTTP header with the following format 'Authorization: Bearer <token>'.

Body

application/json
alert_policy_id
number
required

Associated alert policy ID

name
string
required

Monitor name

protocol
enum<string>
required
Available options:
http,
tcp
request
object
required

Monitoring request, depends of the chosen protocol

interval
enum<number>
required

Monitoring interval in seconds

Available options:
30,
60,
120,
180,
300,
600,
900,
1800,
3600
incident_confirmations
enum<number>
required

Number of uninterrupted failed checks required to create an incident

Available options:
1,
2,
3,
4,
5
recovery_confirmations
enum<number>
required

Number of uninterrupted successful checks required to resolve an incident

Available options:
1,
2,
3,
4,
5
regions
enum<string>[]
required

List of regions where monitoring checks are performed

Available options:
as-ind-bom,
as-jpn-nrt,
as-sgp-sin,
eu-deu-muc,
eu-gbr-lhr,
eu-swe-arn,
na-mex-mex,
na-usa-pdx,
na-usa-ric

Response

201 - application/json
id
number

Monitor ID

project_id
number

Parent project ID

status
enum<string>
Available options:
fetching,
online,
offline,
partial
paused
boolean

Whether the monitor is currently paused

one_day_availability
number

Availability in the last 24h, in percents

one_day_response_time
number | null

Average response time in the last 24h, in milliseconds

alert_policy_id
number
required

Associated alert policy ID

name
string
required

Monitor name

protocol
enum<string>
required
Available options:
http,
tcp
request
object
required

Monitoring request, depends of the chosen protocol

interval
enum<number>
required

Monitoring interval in seconds

Available options:
30,
60,
120,
180,
300,
600,
900,
1800,
3600
incident_confirmations
enum<number>
required

Number of uninterrupted failed checks required to create an incident

Available options:
1,
2,
3,
4,
5
recovery_confirmations
enum<number>
required

Number of uninterrupted successful checks required to resolve an incident

Available options:
1,
2,
3,
4,
5
regions
enum<string>[]
required

List of regions where monitoring checks are performed

Available options:
as-ind-bom,
as-jpn-nrt,
as-sgp-sin,
eu-deu-muc,
eu-gbr-lhr,
eu-swe-arn,
na-mex-mex,
na-usa-pdx,
na-usa-ric
created_at
string

Date of creation for the entity

updated_at
string

Date of last update for the entity

Was this page helpful?

Get a monitorUpdate a monitor