Get All Maintenance Windows

On this page

Required Roles

Request
Request Path Parameters
Request Query Parameters
Request Body Parameters
Response
Response Document
results Embedded Document
Example Request
Example Response
Response Header
Response Body

Retrieve all maintenance windows with end dates 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/

Request Path Parameters

Name	Type	Description
`PROJECT-ID`	string	Unique identifier of the project.

Request Query Parameters

Name

Type

Necessity

Description

Default

pretty

boolean

Optional

Flag indicating whether the response body should be in a prettyprint format.

false

envelope

boolean

Optional

Flag that indicates 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 envelope=true in the query.

For endpoints that return one result, the response body includes:

Name	Description
`status`	HTTP response code
`content`	Expected response body

false

Request Body Parameters

This endpoint doesn't use HTTP request body parameters.

Response

Response Document

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name	Type	Description
`results`	array	Array includes one object for each item detailed in the `results` Embedded Document section.
`links`	array	Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification.
`totalCount`	number	Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

`results` Embedded Document

Each result is one maintenance window.

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.

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"

Example Response

Response Header

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

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1 {
2   "results" : [ {
3     "alertTypeNames" : [ "BACKUP" ],
4     "created" : "2015-10-22T15:04:31Z",
5     "description" : "new description",
6     "endDate" : "2015-10-23T23:30:00Z",
7     "groupId" : "{PROJECT-ID}",
8     "id" : "5628faffd4c606594adaa3b2",
9     "startDate" : "2015-10-23T22:00:00Z",
10     "updated" : "2015-10-22T15:04:31Z",
11     "links" : []
12   }, {
13     "alertTypeNames" : [ "AGENT", "BACKUP" ],
14     "created" : "2015-10-22T15:40:09Z",
15     "endDate" : "2015-10-23T23:30:00Z",
16     "groupId" : "{PROJECT-ID}",
17     "id" : "56290359d4c606594adaafe8",
18     "startDate" : "2015-10-23T22:00:00Z",
19     "updated" : "2015-10-22T15:40:09Z",
20     "links" : []
21   } ],
22   "links" : [],
23   "totalCount" : 2
24 }

Back

Maintenance Windows

Get One Maintenance Window

1	{
2	"results" : [ {
3	"alertTypeNames" : [ "BACKUP" ],
4	"created" : "2015-10-22T15:04:31Z",
5	"description" : "new description",
6	"endDate" : "2015-10-23T23:30:00Z",
7	"groupId" : "{PROJECT-ID}",
8	"id" : "5628faffd4c606594adaa3b2",
9	"startDate" : "2015-10-23T22:00:00Z",
10	"updated" : "2015-10-22T15:04:31Z",
11	"links" : []
12	}, {
13	"alertTypeNames" : [ "AGENT", "BACKUP" ],
14	"created" : "2015-10-22T15:40:09Z",
15	"endDate" : "2015-10-23T23:30:00Z",
16	"groupId" : "{PROJECT-ID}",
17	"id" : "56290359d4c606594adaafe8",
18	"startDate" : "2015-10-23T22:00:00Z",
19	"updated" : "2015-10-22T15:40:09Z",
20	"links" : []
21	} ],
22	"links" : [],
23	"totalCount" : 2
24	}