• API >
• Public API Resources >
• Measurements and Alerts >
• Maintenance Windows >
• Get One Maintenance Window

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://cloud.mongodb.com/api/public/v1.0

copy

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: Name Description status HTTP response code envelope Expected response body	false

Request Body Parameters

This endpoint does not 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

copy

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

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

{
  "alertTypeNames" : [ "AGENT", "BACKUP" ],
  "created" : "2015-10-22T15:04:31Z",
  "description" : "new description",
  "endDate" : "2015-10-23T23:30:00Z",
  "groupId" : "{PROJECT-ID}",
  "id" : "5628faffd4c606594adaa3b2",
  "startDate" : "2015-10-23T22:00:00Z",
  "updated" : "2015-10-22T15:04:31Z",
  "links" : []
}

←   Get All Maintenance Windows Create One Maintenance Window  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.