Get One Maintenance Window

Retrieve one maintenance window with an end date in the future.

Required Roles

You can successfully call this endpoint with any assigned role.

Request

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

GET /groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}

Request Path Parameters

Name	Type	Description
`PROJECT-ID`	string	Unique identifier of the project.
`MW-ID`	string	Unique identifier of the maintenance window you want to retrieve.

Request Query Parameters

Name	Type	Necessity	Description	Default
pretty	boolean	Optional	Flag indicating whether the response body is in a prettyprint format.	`false`
envelope	boolean	Optional	Flag that indicates whether to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes: `status`: HTTP response code `content`: Expected response body	`false`

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

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 appears only if you provide a description of the maintenance window.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --include \     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}"

Example Response

Response Header

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive

HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1{2  "alertTypeNames" : [ "AGENT", "BACKUP" ],3  "created" : "2015-10-22T15:04:31Z",4  "description" : "new description",5  "endDate" : "2015-10-23T23:30:00Z",6  "groupId" : "{PROJECT-ID}",7  "id" : "5628faffd4c606594adaa3b2",8  "startDate" : "2015-10-23T22:00:00Z",9  "updated" : "2015-10-22T15:04:31Z",10  "links" : []11}

Back

Get All

Create