Incidents
an integer specifying the starting point (beginning with 0) when paging through a list of entities
0
the maximum number of results when paging through a list of incidents. (Note: when using ?include maximum is reduced to 25)
10
service IDs of the incident's affected services
from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z, based on reportTime
until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z, based on reportTime
GET /api/incidents HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The incidents
[
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
],
"resolvedOn": "2025-07-08T10:45:54.137Z",
"subscribed": true,
"affectedTeams": [
{
"id": 1,
"name": "text"
}
]
}
]
Note: depending on affected services this will publish notifications to subscribers. Use /publish-info to forecast notifications.
the incident status
May be overwritten during the creation of the incident, otherwise read-only
May be overwritten during the creation of the incident, otherwise read-only
POST /api/incidents HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 377
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
]
}
The newly created incident
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
],
"resolvedOn": "2025-07-08T10:45:54.137Z"
}
Forecast the affected subscribers and status pages as well as notifications that would be send out due to created or update incident.
the incident status
May be overwritten during the creation of the incident, otherwise read-only
May be overwritten during the creation of the incident, otherwise read-only
POST /api/incidents/publish-info HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 377
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
]
}
The forecast for the provided incident
{
"statusPagesInfo": {
"id": 1,
"label": "text"
},
"privateStatusPages": 1,
"publicStatusPages": 1,
"privateSubscribers": 1,
"publicSubscribers": 1
}
Note: returns an ETag header that can be send to the PUT /incidents/{id} resource as If-Match header to return a 412 Error in case any related resources e.g. Services or Incident have been updated in the mean time.
entity ID
GET /api/incidents/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The requested incident
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"history": [
{
"id": "text",
"content": "text",
"creator": {
"id": 1,
"firstName": "text",
"lastName": "text"
},
"incidentStatus": "INVESTIGATING",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z"
}
],
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
],
"resolvedOn": "2025-07-08T10:45:54.137Z",
"subscribed": true,
"affectedTeams": [
{
"id": 1,
"name": "text"
}
]
}
Note: the update will be automatically appended to the incident's update history and publish notifications to subscribers.
entity ID
Should be the ETag response header retrieved from GET /incidents/{id} to prevent updating the incident based on outdated information. Will return 412 status code in case of conflict.
the incident status
May be overwritten during the creation of the incident, otherwise read-only
May be overwritten during the creation of the incident, otherwise read-only
PUT /api/incidents/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 377
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
]
}
The updated incident
{
"id": 1,
"summary": "text",
"status": "INVESTIGATING",
"message": "text",
"sendNotification": true,
"createdAt": "2025-07-08T10:45:54.137Z",
"updatedAt": "2025-07-08T10:45:54.137Z",
"affectedServices": [
{
"impact": "OPERATIONAL",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
}
}
],
"resolvedOn": "2025-07-08T10:45:54.137Z"
}
entity ID
GET /api/incidents/{id}/private-subscribers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
The subscribers of the incident
[
{
"id": 1,
"name": "text",
"type": "USER"
}
]
entity ID
POST /api/incidents/{id}/private-subscribers HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
[
{
"id": 1,
"name": "text",
"type": "USER"
}
]
the response
No content
Was this helpful?