List monitors

GET

uptime

monitors

curl --request GET \
  --url https://api.phare.io/uptime/monitors \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "project_id": 1,
      "status": "fetching",
      "paused": true,
      "response_time": 123,
      "alert_policy_id": 1,
      "name": "Website",
      "protocol": "http",
      "request": {
        "method": "GET",
        "url": "https://docs.phare.io/introduction",
        "keyword": "pong"
      },
      "interval": 60,
      "timeout": 7000,
      "incident_confirmations": 1,
      "recovery_confirmations": 1,
      "regions": [
        "as-ind-bom"
      ],
      "last_checked_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "from": 11,
    "to": 20,
    "per_page": 100,
    "path": "https://api.phare.io/{resource}?page=2"
  },
  "links": {
    "first": "https://api.phare.io/{resource}?page=2",
    "last": "https://api.phare.io/{resource}?page=10",
    "prev": "https://api.phare.io/{resource}?page=1",
    "next": "https://api.phare.io/{resource}?page=1"
  }
}

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

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 <token>'.

Query Parameters

page

integer

default:1

Page number to show

Example:

1

per_page

integer

default:20

Number of ressources to return per page

Required range: 1 <= x <= 100

Example:

20

Response

200

application/json

Success, monitors retrieved

data

object[]

data.alert_policy_id

number

required

Associated alert policy ID

Example:

1

data.name

string

required

Monitor name

Example:

"Website"

data.protocol

enum<string>

required

Available options:

http,

tcp

data.request

object

required

Monitoring request, depends of the chosen protocol

data.interval

enum<number>

required

Monitoring interval in seconds

Available options:

30,

60,

120,

180,

300,

600,

900,

1800,

3600

Example:

60

data.timeout

enum<number>

required

Monitoring timeout in milliseconds

Available options:

1000,

2000,

3000,

4000,

5000,

6000,

7000,

8000,

9000,

10000,

15000,

20000,

25000,

30000

Example:

7000

data.incident_confirmations

enum<number>

required

Number of uninterrupted failed checks required to create an incident

Available options:

1,

2,

3,

4,

5

Example:

1

data.recovery_confirmations

enum<number>

required

Number of uninterrupted successful checks required to resolve an incident

Available options:

1,

2,

3,

4,

5

Example:

1

data.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

data.id

number

Monitor ID

Example:

1

data.project_id

number

Parent project ID

Example:

1

data.status

enum<string>

Available options:

fetching,

online,

offline,

partial

data.paused

boolean

Whether the monitor is currently paused

Example:

true

data.response_time

number | null

Rolling average response time of the last 10 requests, in milliseconds

Example:

123

data.last_checked_at

string | null

Date of the last monitoring check

data.created_at

string

Date of creation for the entity

data.updated_at

string

Date of last update for the entity

meta

object

Meta data for pagination

links

object

Links for pagination

Was this page helpful?

Suggest edits

Delete an alert rule Get a monitor

curl --request GET \
  --url https://api.phare.io/uptime/monitors \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": 1,
      "project_id": 1,
      "status": "fetching",
      "paused": true,
      "response_time": 123,
      "alert_policy_id": 1,
      "name": "Website",
      "protocol": "http",
      "request": {
        "method": "GET",
        "url": "https://docs.phare.io/introduction",
        "keyword": "pong"
      },
      "interval": 60,
      "timeout": 7000,
      "incident_confirmations": 1,
      "recovery_confirmations": 1,
      "regions": [
        "as-ind-bom"
      ],
      "last_checked_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "current_page": 2,
    "from": 11,
    "to": 20,
    "per_page": 100,
    "path": "https://api.phare.io/{resource}?page=2"
  },
  "links": {
    "first": "https://api.phare.io/{resource}?page=2",
    "last": "https://api.phare.io/{resource}?page=10",
    "prev": "https://api.phare.io/{resource}?page=1",
    "next": "https://api.phare.io/{resource}?page=1"
  }
}

API Documentation

Platform

Uptime

List monitors

Authorizations

Query Parameters

Response