List incidents

List incidents

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

{
  "data": [
    {
      "id": 1,
      "organization_id": 1,
      "project_id": 1,
      "title": "Service is not working as expected",
      "slug": "APP-123",
      "impact": "unknown",
      "state": "unknown",
      "status": "ongoing",
      "description": "The server answered with an unexpected status code: 503.",
      "exclude_from_downtime": false,
      "incident_at": "2023-11-07T05:31:56Z",
      "recovery_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"
  }
}

GET

uptime

incidents

List incidents

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

{
  "data": [
    {
      "id": 1,
      "organization_id": 1,
      "project_id": 1,
      "title": "Service is not working as expected",
      "slug": "APP-123",
      "impact": "unknown",
      "state": "unknown",
      "status": "ongoing",
      "description": "The server answered with an unexpected status code: 503.",
      "exclude_from_downtime": false,
      "incident_at": "2023-11-07T05:31:56Z",
      "recovery_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 '.

Query Parameters

page

integer

default:1

Page number to show

Example:

1

per_page

integer

default:20

Number of resources to return per page

Required range: 1 <= x <= 100

Example:

20

Response

Success, incidents retrieved

data

object[]

Show child attributes

data.id

number

Example:

1

data.organization_id

number

Parent organization ID

Example:

1

data.project_id

number

Parent project ID

Example:

1

data.title

string

Incident title

Example:

"Service is not working as expected"

data.slug

string

Incident unique slug name

Example:

"APP-123"

data.impact

enum<string>

Available options:

unknown,

operational,

degradedPerformance,

partialOutage,

majorOutage,

maintenance

data.state

enum<string>

Available options:

unknown,

investigating,

identified,

monitoring,

resolved

data.status

enum<string>

Available options:

ongoing,

recovering,

recovered

data.description

string

Description of the error that caused the incident

Example:

"The server answered with an unexpected status code: 503."

data.exclude_from_downtime

boolean

Flag to exclude the incident from downtime calculations

Example:

false

data.incident_at

string<date-time> | null

Date of incident confirmation

data.recovery_at

string<date-time> | null

Date of incident recovery

data.created_at

string<date-time>

Date of creation for the entity

data.updated_at

string<date-time>

Date of last update for the entity

API Documentation

Platform

Uptime

Authorizations

Query Parameters

Response