GET
/
{product}
/
alert-policies
/
{alertPolicyId}
/
alert-rules
/
{alertRuleId}
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>'.

Path Parameters

​
product
enum<string>
required

The Phare product

Available options:
uptime
​
alertPolicyId
integer
required

ID of the alert policy to update

​
alertRuleId
integer
required

ID of the alert rule to update

Response

200 - application/json
​
integration_id
number
required

The ID of the integration used to send a notification when the alert rule is executed

​
event
enum<string>
required

Name of the event that will trigger the execution of the alert rule

Available options:
uptime.monitor.created,
uptime.monitor.deleted,
uptime.incident.created,
uptime.incident.recovered,
uptime.incident_comment.created,
uptime.incident_update.published
​
rate_limit
enum<number>
required

Minimum time in minutes between two executions of the alert rule, used to minimized the number of alert received.

Available options:
0,
5,
10,
30,
60,
180,
720,
1440
​
id
number
​
alert_policy_id
number

Parent alert policy ID

​
created_at
string

Date of creation for the entity

​
updated_at
string

Date of last update for the entity

Was this page helpful?

Create an alert ruleUpdate an alert rule