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

200

{
    "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 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

200

{
    "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
}

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

200

{
    "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
}

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

200

{
    "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 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

200

{
    "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
}