Downtimes

API Calls

Name	Description	Shortcut
GET: List Downtimes resources Request	This method can be used to retrieve a list of current downtime resources per date.	Description
POST: Create a new downtime resource	This method can be used to create a new downtime resource	Description
DELETE: Delete a downtime resource	This method can be used to delete an existing downtime resource	Description

[GET]: List downtime resources

This method can be used to retrieve a list of current downtime resources per date

Input

GET /downtimes?date=YYYY-MM-DD

Optional Query Parameters

Type	Description	Required
date	Date to retrieve a historic version of the downtime resource. If no date parameter is provided the most current resource will be returned	NO
classification	optionally filter downtimes by classification value	NO
severity	optionally filter downtiumes by severity value	NO

Request headers

x-api-key: shared_key_value
Accept: application/json

Response

Headers: Status: 200 OK

Response body

Json Response

{
    "status": {
        "message": "Success",
        "code": "200"
    },
    "data": [
        {
            "date": "2019-11-04",
            "endpoints": [
                {
                    "hostname": "host-A",
                    "service": "service-A",
                    "start_time": "2019-10-11T04:00:33Z",
                    "end_time": "2019-10-11T15:33:00Z",
                    "description": "a simple optional description",
                    "severity": "optional severity value like critical, warning",
                    "classification": "optional classification value like outage, scheduled"
                },
                {
                    "hostname": "host-B",
                    "service": "service-B",
                    "start_time": "2019-10-11T12:00:33Z",
                    "end_time": "2019-10-11T12:33:00Z"
                },
                {
                    "hostname": "host-C",
                    "service": "service-C",
                    "start_time": "2019-10-11T20:00:33Z",
                    "end_time": "2019-10-11T22:15:00Z"
                }
            ]
        }
    ]
}

Request downtimes and filter by severity and classification example

In the following example we request the downtimes for the date 2022-05-11 that are of outage severity and classified as unscheduled

HTTP GET /api/v2/downtimes?date=2022-05-11&severity=outage&classification=outage

Response: 200 OK Body:

{
    "status": {
        "message": "Success",
        "code": "200"
    },
    "data": [
        {
            "date": "2022-05-11",
            "endpoints": [
                {
                    "hostname": "host-A",
                    "service": "service-A",
                    "start_time": "2022-05-11T04:00:33Z",
                    "end_time": "2022-05-11T15:33:00Z",
                    "severity": "outage",
                    "classification": "unscheduled"
                },
                {
                    "hostname": "host-B",
                    "service": "service-B",
                    "start_time": "2022-05-11T12:00:33Z",
                    "end_time": "2022-05-11T12:33:00Z",
                    "severity": "outage",
                    "classification": "unscheduled",
                    "description": "a simple description",
                }
            ]
        }
    ]
}

note: description, severity and classification but quite useful to organise the kind of downtimes declared per day.

[POST]: Create a new downtime resource

This method can be used to insert a new downtime resource

Input

POST /downtimes?date=YYYY-MM-DD

Optional Query Parameters

Type	Description	Required
date	Date to create a new historic version of the downtime resource. If no date parameter is provided current date will be supplied automatically	NO

Request headers

x-api-key: shared_key_value
Accept: application/json

POST BODY

{
    "endpoints": [
        {
            "hostname": "host-foo",
            "service": "service-new-foo",
            "start_time": "2019-10-11T23:10:00Z",
            "end_time": "2019-10-11T23:25:00Z",
            "classification": "unscheduled",
            "severity": "outage",
        },
        {
            "hostname": "host-bar",
            "service": "service-new-bar",
            "start_time": "2019-10-11T23:40:00Z",
            "end_time": "2019-10-11T23:55:00Z",
            "classification": "unscheduled",
            "severity": "outage",
        }
    ]
}

Response

Headers: Status: 201 Created

Response body

Json Response

{
 "status": {
  "message": "Downtimes set created for date: 2019-11-29",
  "code": "201"
 }
}

[DELETE]: Delete an existing downtime resource

This method can be used to delete an existing downtime resource

Input

DELETE /downtimes?date=YYYY-MM-DD

Request headers

x-api-key: shared_key_value
Accept: application/json

Response

Headers: Status: 200 OK

Response body

Json Response

{
 "status": {
  "message": "Downtimes set deleted for date: 2019-10-11",
  "code": "200"
 }
}