Maintenance API

You can list, get, create, update, delete maintenances via our API. Maintenances let you inform your customers prior to the change that will/might impact them.

get
List Maintenances

https://api.statusentry.com/v1/maintenances
This endpoint allows you to list all maintenances.
Request
Response
Request
Headers
Authorization
required
string
Authorization Token
Response
200: OK
{
"customerId": "b81b5166-7a8f-4046-9cd6-482cd7ecb032",
"maintenances": [
{
"customerId": "b81b5166-7a8f-4046-9cd6-482cd7ecb032",
"id": "5e910045-7272-4562-bef5-0eddf32a1c8d",
"name": "We will update our login mechanism",
"message": "We will switch to another provider. During this transition, we expect to observe intermittent login failures.",
"plannedStartTime": "2021-04-03T21:19:00.791Z",
"plannedEndTime": "2021-04-03T21:24:00.791Z",
"affectedComponents": [
{
"componentId": "29db6fd6-9d5d-4c8c-8cc7-e072f3e08f67"
}
],
"sendNotification": true,
"internal": false
}
]
}

get
Get Maintenance

https://api.statusentry.com/v1/maintenances/:id
This endpoint allows you to retrieve a specific maintenance.
Request
Response
Request
Path Parameters
required
string
ID of the maintenance
Headers
Authorization
required
string
Authorization Token
Response
200: OK
{
"customerId": "b81b5166-7a8f-4046-9cd6-482cd7ecb032",
"id": "5e910045-7272-4562-bef5-0eddf32a1c8d",
"name": "We will update our login mechanism",
"message": "We will switch to another provider. During this transition, we expect to observe intermittent login failures.",
"plannedStartTime": "2021-04-03T21:19:00.791Z",
"plannedEndTime": "2021-04-03T21:24:00.791Z",
"affectedComponents": [
{
"componentId": "29db6fd6-9d5d-4c8c-8cc7-e072f3e08f67"
}
],
"sendNotification": true,
"internal": false
}

post
Create Maintenance

https://api.statusentry.com/v1/maintenances
This endpoint allows you to create a new maintenance.
Request
Response
Request
Headers
Authorization
required
string
Authorization Token
Body Parameters
name
required
string
Maintenance Name
message
required
string
Maintenance Message
plannedStartTime
required
number
Planned Maintenance Start Time (Epoch time in milliseconds)
plannedEndTime
optional
number
Planned Maintenance Completion Time (Epoch time in milliseconds)
affectedComponents
optional
array
Affected Component ID List
sendNotification
optional
boolean
Should send notification
internal
optional
boolean
Internal maintenance
Response
200: OK
{
"customerId": "b81b5166-7a8f-4046-9cd6-482cd7ecb032",
"id": "5e910045-7272-4562-bef5-0eddf32a1c8d",
"name": "We will update our login mechanism",
"message": "We will switch to another provider. During this transition, we expect to observe intermittent login failures.",
"plannedStartTime": "2021-04-03T21:19:00.791Z",
"plannedEndTime": "2021-04-03T21:24:00.791Z",
"affectedComponents": [
{
"componentId": "29db6fd6-9d5d-4c8c-8cc7-e072f3e08f67"
}
],
"sendNotification": true,
"internal": false
}

put
Update Maintenance

https://api.statusentry.com/v1/maintenances/:id
This endpoint allows you to update all of the fields of an existing maintenance.
Request
Response
Request
Path Parameters
id
optional
string
Maintenance ID
Headers
Authorization
required
string
Authorization Token
Body Parameters
name
required
string
Maintenance Name
message
required
string
Maintenance Message
plannedStartTime
required
number
Planned Maintenance Start Time (Epoch time in milliseconds)
plannedEndTime
optional
number
Planned Maintenance Completion Time (Epoch time in milliseconds)
affectedComponents
optional
array
Affected Component ID List
sendNotification
optional
boolean
Should send notification
internal
optional
boolean
Internal maintenance
Response
200: OK
{
"customerId": "b81b5166-7a8f-4046-9cd6-482cd7ecb032",
"id": "5e910045-7272-4562-bef5-0eddf32a1c8d",
"name": "We will update our login mechanism",
"message": "We will switch to another provider. During this transition, we expect to observe intermittent login failures.",
"plannedStartTime": "2021-04-03T21:19:00.791Z",
"plannedEndTime": "2021-04-03T21:24:00.791Z",
"affectedComponents": [
{
"componentId": "29db6fd6-9d5d-4c8c-8cc7-e072f3e08f67"
}
],
"sendNotification": true,
"internal": false
}

delete
Delete Maintenance

https://api.statusentry.com/v1/maintenances/:id
This endpoint allows you to delete a specific maintenance.
Request
Response
Request
Path Parameters
required
string
ID of the maintenance
Headers
Authorization
required
string
Authorization Token
Response
200: OK
{
"customerId": "b81b5166-7a8f-4046-9cd6-482cd7ecb032",
"id": "5e910045-7272-4562-bef5-0eddf32a1c8d",
"name": "We will update our login mechanism",
"message": "We will switch to another provider. During this transition, we expect to observe intermittent login failures.",
"plannedStartTime": "2021-04-03T21:19:00.791Z",
"plannedEndTime": "2021-04-03T21:24:00.791Z",
"affectedComponents": [
{
"componentId": "29db6fd6-9d5d-4c8c-8cc7-e072f3e08f67"
}
],
"sendNotification": true,
"internal": false
}

‚Äč