Get all downtimes
GET {{baseUrl}}/api/v2/downtime?current_only=<boolean>&include=<string>&page[offset]=0&page[limit]=30
Get all scheduled downtimes.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
current_only | string | 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":"\u003cdateTime\u003e","created":"\u003cdateTime\u003e","display_timezone":"UTC","message":"\u003cstring\u003e","modified":"\u003cdateTime\u003e","monitor_identifier":{"monitor_id":"\u003clong\u003e"},"mute_first_recovery_notification":"\u003cboolean\u003e","notify_end_states":["no data","no data"],"notify_end_types":["canceled","canceled"],"schedule":{"recurrences":[{"duration":"\u003cstring\u003e","rrule":"\u003cstring\u003e","start":"\u003cstring\u003e"}],"current_downtime":{"end":"\u003cdateTime\u003e","start":"\u003cdateTime\u003e"},"timezone":"UTC"},"scope":"\u003cstring\u003e","status":"active"},"id":"\u003cstring\u003e","relationships":{"created_by":{"data":{"id":"\u003cstring\u003e","type":"users"}},"monitor":{"data":{"id":"\u003cstring\u003e","type":"monitors"}}},"type":"downtime"},{"attributes":{"canceled":"\u003cdateTime\u003e","created":"\u003cdateTime\u003e","display_timezone":"UTC","message":"\u003cstring\u003e","modified":"\u003cdateTime\u003e","monitor_identifier":{"monitor_id":"\u003clong\u003e"},"mute_first_recovery_notification":"\u003cboolean\u003e","notify_end_states":["warn","alert"],"notify_end_types":["canceled","canceled"],"schedule":{"recurrences":[{"duration":"\u003cstring\u003e","rrule":"\u003cstring\u003e","start":"\u003cstring\u003e"}],"current_downtime":{"end":"\u003cdateTime\u003e","start":"\u003cdateTime\u003e"},"timezone":"UTC"},"scope":"\u003cstring\u003e","status":"scheduled"},"id":"\u003cstring\u003e","relationships":{"created_by":{"data":{"id":"\u003cstring\u003e","type":"users"}},"monitor":{"data":{"id":"\u003cstring\u003e","type":"monitors"}}},"type":"downtime"}],"included":[{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"},{"attributes":{"created_at":"\u003cdateTime\u003e","disabled":"\u003cboolean\u003e","email":"\u003cstring\u003e","handle":"\u003cstring\u003e","icon":"\u003cstring\u003e","modified_at":"\u003cdateTime\u003e","name":"\u003cstring\u003e","service_account":"\u003cboolean\u003e","status":"\u003cstring\u003e","title":"\u003cstring\u003e","verified":"\u003cboolean\u003e"},"id":"\u003cstring\u003e","relationships":{"org":{"data":{"id":"\u003cstring\u003e","type":"orgs"}},"other_orgs":{"data":[{"id":"\u003cstring\u003e","type":"orgs"},{"id":"\u003cstring\u003e","type":"orgs"}]},"other_users":{"data":[{"id":"\u003cstring\u003e","type":"users"},{"id":"\u003cstring\u003e","type":"users"}]},"roles":{"data":[{"id":"\u003cstring\u003e","type":"roles"},{"id":"\u003cstring\u003e","type":"roles"}]}},"type":"users"}],"meta":{"page":{"total_filtered_count":"\u003clong\u003e"}}}