GET
/
uptime
/
status-pages
/
{statusPageId}
/
current-status
curl --request GET \
  --url https://api.phare.io/uptime/status-pages/{statusPageId}/current-status \
  --header 'Authorization: Bearer <token>'
{
  "current_incident_impact": "unknown",
  "availability": 99.9999,
  "updated_at": "2023-11-07T05:31:56Z",
  "components": [
    {
      "type": "uptime/monitor",
      "name": "Website",
      "response_time": 123,
      "availability": 99.9999,
      "current_incident_impact": "unknown"
    }
  ],
  "active_incidents": [
    {
      "id": 1,
      "title": "Service is not working as expected",
      "impact": "unknown",
      "state": "unknown",
      "status": "ongoing",
      "exclude_from_downtime": false,
      "incident_at": "2023-11-07T05:31:56Z",
      "recovery_at": "2023-11-07T05:31:56Z"
    }
  ]
}
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>'.

Path Parameters

​
statusPageId
integer
required

ID of the status page to show the current status for

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, status page current status retrieved
​
current_incident_impact
enum<string>
Available options:
unknown,
operational,
degradedPerformance,
partialOutage,
majorOutage,
maintenance
​
availability
number

Average availability of all associated monitors in the last 90 days, in percents

Example:

99.9999

​
updated_at
string

Date of the data calculation

​
components
object[]

Components of the status page and their current status

​
active_incidents
object[]

Active incidents linked to the status page

Was this page helpful?

Suggest edits