Maintenance Updates API Reference

Get a maintenance update

Endpoint:

GET /v1/:page_id/maintenances/:maintenance_id/maintenance-updates/:maintenance_update_id

Example response

{
"id": "ckf1g4ffi4o5y0a35rm76vuq9",
"message": "We're currently investigating an issue with the Website",
"messageHtml": "<p>We're currently investigating an issue with the Website</p>",
"notify": true,
"started": "2020-09-12T03:38:47.998Z",
"status": "NOTSTARTEDYET",
"maintenance": {
"id": "ckf1g4evp4o5s0a35vozxnjv5",
"name": "Test maintenance 2",
"start": "2020-09-12T03:38:47.998Z",
"status": "NOTSTARTEDYET",
"components": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"showUptime": true,
"site": {
"id": "ckf01fonve9i40a32oas5b0uw",
"name": "Nasa",
"subdomain": "nasa",
"color": null,
"logoUrl": null,
"publicEmail": null
}
}
]
}
}

Add an maintenance update

Endpoint:

POST /v1/:page_id/maintenances/:maintenance_id/maintenance-updates

Example request

{
"message": "We are scheduling a test maintenance",
"components": ["ckf01fvnxywz50a35nh1qzssm"],
"started": "2020-09-12 05:38:47.998",
"end": "2020-09-12 06:38:47.998",
"status": "NOTSTARTEDYET",
"notify": true,
"statuses": [
{
"id": "ckebhqpxnrk1c0a3588oztaty",
"status": "UNDERMAINTENANCE"
}
]
}

Example response

{
"id": "ckf1hlezn4vzv0a358mh8jg0z",
"message": "We are scheduling a test maintenance",
"messageHtml": "<p>We are scheduling a test maintenance</p>",
"notify": true,
"started": "2020-09-12T03:38:47.998Z",
"status": "NOTSTARTEDYET",
"maintenance": {
"id": "ckf1hdrlilhvr0a32pyllguzs",
"name": "Maintenance test",
"start": "2020-09-12T03:38:47.998Z",
"status": "NOTSTARTEDYET",
"components": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"showUptime": true,
"subscribers": [],
"site": {
"id": "ckf01fonve9i40a32oas5b0uw",
"name": "Nasa",
"subdomain": "nasa",
"color": null,
"logoUrl": null,
"publicEmail": null,
"subscribers": []
}
}
]
}
}

Edit an maintenance update

Endpoint:

PUT /v1/:page_id/maintenances/:maintenance_id/maintenance-updates/:maintenance_update_id

Example request

{
"message": "We are scheduling a test maintenance 2",
"components": ["ckf01fvnxywz50a35nh1qzssm"],
"started": "2020-09-12 05:38:47.998",
"end": "2020-09-12 06:38:47.998",
"status": "NOTSTARTEDYET",
"notify": true,
"statuses": [
{
"id": "ckebhqpxnrk1c0a3588oztaty",
"status": "UNDERMAINTENANCE"
}
]
}

Example response

{
"id": "ckf1hlezn4vzv0a358mh8jg0z",
"message": "We are scheduling a test maintenance 2",
"messageHtml": "<p>We are scheduling a test maintenance 2</p>",
"notify": true,
"started": "2020-09-12T03:38:47.998Z",
"status": "NOTSTARTEDYET",
"maintenance": {
"id": "ckf1hdrlilhvr0a32pyllguzs",
"name": "Maintenance test",
"start": "2020-09-12T03:38:47.998Z",
"status": "NOTSTARTEDYET",
"components": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"showUptime": true,
"subscribers": [],
"site": {
"id": "ckf01fonve9i40a32oas5b0uw",
"name": "Nasa",
"subdomain": "nasa",
"color": null,
"logoUrl": null,
"publicEmail": null,
"subscribers": []
}
}
]
}
}

Delete an maintenance update

Endpoint:

DELETE /v1/:page_id/maintenances/:maintenance_id/maintenance-updates/:maintenance_update_id

Example response

{
"id": "ckf1hlezn4vzv0a358mh8jg0z"
}