- API >
- Public API Resources >
- Measurements and Alerts >
- Maintenance Windows >
- Create One Maintenance Window
Create One Maintenance Window¶
On this page
Create one maintenance window. Ops Manager turns off alert notifications for certain alert types for a period of time you specify to allow maintenance to occur.
Required Roles¶
You can successfully call this endpoint with any of the following assigned roles:
Request¶
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Request Path Parameters¶
Name | Type | Description |
---|---|---|
PROJECT-ID |
string | Unique identifier of the project. |
Request Query Parameters¶
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Flag indicating whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Flag indicating whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
Body Parameter | Type | Necessity | Description |
---|---|---|---|
alertTypeNames |
array of strings | Required | Alert types to silence during maintenance window. For example:
HOST , REPLICA_SET , CLUSTER , AGENT , BACKUP |
startDate |
string | Required | Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts. |
endDate |
string | Required | Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends. |
description |
string | Optional | Description of the maintenance window. |
Response¶
Name | Type | Description |
---|---|---|
id |
string | Unique identifier of the maintenance window. |
groupId |
string | Unique identifier of the project to which this maintenance window applies. |
created |
string | Timestamp in ISO 8601 date and time format in UTC when the maintenance window was created. |
updated |
string | Timestamp in ISO 8601 date and time format in UTC when the maintenance window was last updated. |
startDate |
string | Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts. |
endDate |
string | Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends. |
alertTypeNames |
array of strings | Alert types to silence during maintenance window. For example:
HOST , REPLICA_SET , CLUSTER , AGENT , BACKUP |
description |
string | Description of the maintenance window. This field is returned only if you provided a description of the maintenance window. |