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.
List Maintenances
GET
https://api.statusentry.com/v1/maintenances
This endpoint allows you to list all maintenances.
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Get Maintenance
GET
https://api.statusentry.com/v1/maintenances/:id
This endpoint allows you to retrieve a specific maintenance.
Path Parameters
Name | Type | Description |
---|---|---|
string | ID of the maintenance |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Create Maintenance
POST
https://api.statusentry.com/v1/maintenances
This endpoint allows you to create a new maintenance.
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Request Body
Name | Type | Description |
---|---|---|
name | string | Maintenance Name |
message | string | Maintenance Message |
plannedStartTime | number | Planned Maintenance Start Time (Epoch time in milliseconds) |
plannedEndTime | number | Planned Maintenance Completion Time (Epoch time in milliseconds) |
affectedComponents | array | Affected Component ID List |
sendNotification | boolean | Should send notification |
internal | boolean | Internal maintenance |
Update Maintenance
PUT
https://api.statusentry.com/v1/maintenances/:id
This endpoint allows you to update all of the fields of an existing maintenance.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | Maintenance ID |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Request Body
Name | Type | Description |
---|---|---|
name | string | Maintenance Name |
message | string | Maintenance Message |
plannedStartTime | number | Planned Maintenance Start Time (Epoch time in milliseconds) |
plannedEndTime | number | Planned Maintenance Completion Time (Epoch time in milliseconds) |
affectedComponents | array | Affected Component ID List |
sendNotification | boolean | Should send notification |
internal | boolean | Internal maintenance |
Delete Maintenance
DELETE
https://api.statusentry.com/v1/maintenances/:id
This endpoint allows you to delete a specific maintenance.
Path Parameters
Name | Type | Description |
---|---|---|
string | ID of the maintenance |
Headers
Name | Type | Description |
---|---|---|
Authorization | string | Authorization Token |
Last updated