Incidents
Get an incident
Incidents
Get an incident
Get an incident by ID
GET
/
uptime
/
incidents
/
{incidentId}
Please be aware that the Phare API is currently in beta and is subject to change.
Authorizations
Authorization
string
headerrequiredUse 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
incidentId
integer
requiredID of the incident to show
Response
200 - application/json
id
number
organization_id
number
Parent organization ID
project_id
number
Parent project ID
uptime_monitor_id
number
Parent uptime monitor ID
title
string
Incident title
slug
string
Incident unique slug name
impact
enum<string>
Available options:
unknown, operational, degradedPerformance, partialOutage, majorOutage, maintenance state
enum<string>
Available options:
unknown, investigating, identified, monitoring, resolved status
enum<string>
Available options:
ongoing, recovering, recovered description
string
Description of the error that caused the incident
exclude_from_downtime
boolean
Flag to exclude the incident from downtime calculations
incident_at
string | null
Date of incident confirmation
recovery_at
string | null
Date of incident recovery
created_at
string
Date of creation for the entity
updated_at
string
Date of last update for the entity
Was this page helpful?