Get One Maintenance Window
On this page
Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
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://cloud.mongodb.com/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 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:
| 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 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://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}"
Example Response
Response Header
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
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 "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 }