Get all downtimes
GET {{baseUrl}}/api/v2/downtime
Get all scheduled downtimes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
current_only | boolean | Only return downtimes that are active when the request is made. | |
include | string | Comma-separated list of resource paths for related resources to include in the response. Supported resource | |
paths are created_by and monitor. | |||
page[offset] | number | Specific offset to use as the beginning of the returned page. | |
page[limit] | number | Maximum number of downtimes in the response. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"attributes":{"canceled":"2020-01-02T03:04:05.282979+0000","created":"2020-01-02T03:04:05.282979+0000","display_timezone":"America/New_York","message":"Message about the downtime","modified":"2020-01-02T03:04:05.282979+0000","monitor_identifier":{"monitor_id":123},"mute_first_recovery_notification":false,"notify_end_states":["alert","warn"],"notify_end_types":["canceled","expired"],"schedule":{"recurrences":[{"duration":"123d","rrule":"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1","start":"2020-01-02T03:04"}],"current_downtime":{"end":"2020-01-02T03:04:00.000Z","start":"2020-01-02T03:04:00.000Z"},"timezone":"America/New_York"},"scope":"env:(staging OR prod) AND datacenter:us-east-1","status":"active"},"id":"00000000-0000-1234-0000-000000000000","relationships":{"created_by":{"data":{"id":"00000000-0000-1234-0000-000000000000","type":"users"}},"monitor":{"data":{"id":"12345","type":"monitors"}}},"type":"downtime"},{"attributes":{"canceled":"2020-01-02T03:04:05.282979+0000","created":"2020-01-02T03:04:05.282979+0000","display_timezone":"America/New_York","message":"Message about the downtime","modified":"2020-01-02T03:04:05.282979+0000","monitor_identifier":{"monitor_id":123},"mute_first_recovery_notification":false,"notify_end_states":["alert","warn"],"notify_end_types":["canceled","expired"],"schedule":{"recurrences":[{"duration":"123d","rrule":"FREQ=MONTHLY;BYSETPOS=3;BYDAY=WE;INTERVAL=1","start":"2020-01-02T03:04"}],"current_downtime":{"end":"2020-01-02T03:04:00.000Z","start":"2020-01-02T03:04:00.000Z"},"timezone":"America/New_York"},"scope":"env:(staging OR prod) AND datacenter:us-east-1","status":"active"},"id":"00000000-0000-1234-0000-000000000000","relationships":{"created_by":{"data":{"id":"00000000-0000-1234-0000-000000000000","type":"users"}},"monitor":{"data":{"id":"12345","type":"monitors"}}},"type":"downtime"}],"included":[{"attributes":{"created_at":"1955-04-22T16:11:51.568Z","disabled":false,"email":"esse ut","handle":"des","icon":"sed Excepteur ex","modified_at":"2010-07-30T04:31:51.727Z","name":"consequat anim","service_account":false,"status":"quis elit id adipisicing voluptate","title":"amet magna nostrud","verified":false},"id":"adipisicing sed","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"1961-04-17T07:59:29.050Z","disabled":false,"email":"eu","handle":"amet","icon":"proident ipsum labore pariatur do","modified_at":"1957-12-19T08:55:09.761Z","name":"anim Exce","service_account":false,"status":"eli","title":"commodo Excepteur in","verified":false},"id":"reprehenderit sint sit et Lorem","relationships":{"org":{"data":{"id":"00000000-0000-beef-0000-000000000000","type":"orgs"}},"other_orgs":{"data":[]},"other_users":{"data":[]},"roles":{"data":[{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"},{"id":"3653d3c6-0c75-11ea-ad28-fb5701eabc7d","type":"roles"}]}},"type":"users"}],"meta":{"page":{"total_filtered_count":43080922}}}