Skip to main content
GET
/
alert-rules
/
{alertRuleId}
Get an alert rule
curl --request GET \
  --url https://api.phare.io/alert-rules/{alertRuleId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.phare.io/alert-rules/{alertRuleId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.phare.io/alert-rules/{alertRuleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.phare.io/alert-rules/{alertRuleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.phare.io/alert-rules/{alertRuleId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.phare.io/alert-rules/{alertRuleId}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.phare.io/alert-rules/{alertRuleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "integration_id": 1,
  "rate_limit": 5,
  "id": 1,
  "project_id": 1,
  "event_settings": {},
  "integration_settings": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"message": "Unauthorized"
}
{
"message": "The platform:write permission is required to perform this action."
}
{
"message": "Resource not found"
}

Authorizations

Authorization
string
header
required

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

Headers

X-Phare-Project-Id
integer

A project header is required when using an organization-scoped API key.

Example:

1

X-Phare-Project-Slug
string

A project header is required when using an organization-scoped API key.

Example:

"luminous-guiding-tower"

Path Parameters

alertRuleId
integer
required

ID of the alert rule to show

Response

Success, alert rule retrieved

event
enum<string>
required
Available options:
uptime.monitor.created,
uptime.monitor.deleted,
uptime.monitor_certificate.discovered,
uptime.monitor_certificate.expiring,
uptime.incident.created,
uptime.incident.propagated,
uptime.incident.partially_recovered,
uptime.incident.recovered,
uptime.incident_comment.created,
uptime.incident_update.published
integration_id
integer
required

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

Example:

1

rate_limit
enum<integer>
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
Example:

5

id
integer
Example:

1

project_id
integer | null

The ID of a project to use as a scope

Example:

1

event_settings
Empty · object

Additional settings for the event

integration_settings
Empty · object

Additional settings for the integration

created_at
string<date-time>

Date of creation for the entity

updated_at
string<date-time>

Date of last update for the entity

Last modified on February 8, 2026