- API >
- Public API Resources >
- Measurements and Alerts >
- Maintenance Windows
Maintenance Windows¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
The maintenanceWindows
resource turns off alert notifications for
specified alert types for a period of time, to allow maintenance to occur.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Endpoints¶
Get All Maintenance Windows¶
Get all maintenance windows with end dates in the future.
Get a Single Maintenance Window by its ID¶
Create a Maintenance Window¶
The resource requires the following fields:
alertTypeNames
startDate
endDate
Update a Maintenance Window¶
Delete a Maintenance Window¶
Sample Entity¶
The following is a sample return document.
Entity Fields¶
Name | Type | Description |
---|---|---|
id | string | unique identifier |
groupId | string | Unique identifier of the group that owns this maintenance window config |
created | date | When this maintenance window config was created. |
updated | date | When this maintenance window config was last updated. |
startDate | date | Start date for the maintenance window. |
endDate | date | The end date for the maintenance window. It must be after startDate . |
alertTypeNames | string array | Alert types to silence during maintenance window. For example:
HOST , REPLICA_SET , CLUSTER , AGENT , BACKUP |
description | string | Description of the maintenance window. This field might not exist. |
Links¶
Relation | Description |
---|---|
self | Me |
group | The group that owns this maintenance window config. |