Service Outages
Authorizations
Query parameters
servicenumberOptional
the id of the service for which the outages should be fetched
fromstring · date-timeOptional
from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z
untilstring · date-timeOptional
until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z
ignore-overridesbooleanOptional
if the outages should not take overrides into account, default is false
Responses
200
The outages of the service
application/json
get
GET /api/service-outages HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
The outages of the service
[
{
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
]
Authorizations
Query parameters
servicenumberOptional
the id of the service for which the overrides should be fetched
fromstring · date-timeOptional
from date, ISO-UTC e.g. 2021-05-25T21:24:56.771Z
untilstring · date-timeOptional
until date, ISO-UTC e.g. 2021-05-26T21:24:56.771Z
Responses
200
The overrides of the service
application/json
get
GET /api/service-outages/overrides HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
The overrides of the service
[
{
"id": "text",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
},
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
]
Authorizations
Body
idstringOptional
statusstring · enumOptionalPossible values:
the service status
fromstring · date-timeOptional
untilstring · date-timeOptional
Responses
201
The added override
application/json
post
POST /api/service-outages/overrides HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"id": "text",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
},
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
201
The added override
{
"id": "text",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
},
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Responses
200
The override
application/json
get
GET /api/service-outages/overrides/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
200
The override
{
"id": "text",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
},
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
Authorizations
Path parameters
idnumberRequired
entity ID
Body
idstringOptional
statusstring · enumOptionalPossible values:
the service status
fromstring · date-timeOptional
untilstring · date-timeOptional
Responses
200
The updated override
application/json
put
PUT /api/service-outages/overrides/{id} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"id": "text",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
},
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
200
The updated override
{
"id": "text",
"service": {
"id": 1,
"name": "text",
"status": "OPERATIONAL",
"description": "text",
"oneOpenIncidentOnly": true,
"showUptimeHistory": true,
"teams": [
{
"id": 1,
"name": "text"
}
]
},
"status": "OPERATIONAL",
"from": "2025-07-08T10:45:54.931Z",
"until": "2025-07-08T10:45:54.931Z"
}
Was this helpful?