The monitors a maintenance window matches by tag or service, and the alerts held for each now.

GET

/maintenance_windows/{window_id}/coverage

curl --request GET \
  --url https://api.siteqwality.com/maintenance_windows/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/coverage \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

window_id

required

string format: uuid

Maintenance window identifier

Responses

200

What the window holds

Media type application/json

What a window holds: the monitors it matches and the alerts held for each right now.

object

window_id

required

string format: uuid

is_currently_active

required

Whether the window is in effect now; held alerts go out when it ends.

boolean

monitors

required

Array<object>

object

monitor_type

required

http, cron, browser, tls, dns, dns_record or page_speed.

string

monitor_id

required

string format: uuid

name

required

string

service_id

string | null format: uuid

held_alerts

required

Alerts this window or another one holds for the monitor right now.

integer format: int64

held_alerts

required

Alerts held right now across these monitors.

integer format: int64

truncated

required

More than 500 monitors match; the list is cut.

boolean

Example ^generated

{
  "window_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "is_currently_active": true,
  "monitors": [
    {
      "monitor_type": "example",
      "monitor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "held_alerts": 1
    }
  ],
  "held_alerts": 1,
  "truncated": true
}

401

Missing or invalid authentication

404

Window not found

500

Internal server error