Navigation

Get the Maintenance Window for One Project

Important With Circle IconCreated with Sketch.Important
Maintenance Window Considerations
Urgent Maintenance Activities
Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.
Ongoing Maintenance Operations
Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.
Maintenance Requires Replica Set Elections
Atlas performs maintenance the same way as the maintenance procedure described in the MongoDB Manual. This procedure requires at least one replica set election during the maintenance window per replica set.
Maintenance Starts As Close to the Hour As Possible
Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or unexpected system issues could delay the start time.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

GET /groups/{GROUP-ID}/maintenanceWindow
NameTypeDescription
GROUP-IDstringUnique identifier of the project from which you want to retrieve the Maintenance Window.

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

NameTypeNecessityDescriptionDefault
pageNumintegerOptionalPage number (1-based).1
itemsPerPageintegerOptionalMaximum number of items to return, up to a maximum of 100.100
includeCountbooleanOptionalSpecifies whether the response returns the totalCount field.true
prettybooleanOptionalIndicates whether the response body should be in a prettyprint format.false
envelopebooleanOptional

Flag indicating if Atlas should wrap the response in a JSON 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:

statusHTTP response code
envelopeExpected response body

For endpoints that return a list of results, the results object is an envelope. Atlas adds the status field to the response body.

false

This endpoint doesn't use HTTP request body parameters.

NameTypeDescription
dayOfWeeknumber

Day of the week when you would like the maintenance window to start as a 1-based integer.

Day of WeekInteger
Sunday1
Monday2
Tuesday3
Wednesday4
Thursday5
Friday6
Saturday7
hourOfDaynumberHour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12.
startASAPboolean

Flag indicating that you want the maintenance window to start immediately upon receiving this request.

To use startASAP : true, You need to have scheduled maintenance and set your own maintenance window.

After you set startASAP : true, the project's maintenance starts immediately. startASAP resets to false after Atlas completes maintenance.

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/maintenanceWindow?pretty=true"

If the current maintenance window is user defined, this endpoint returns the following response.

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}
{
"dayOfWeek" : 1,
"hourOfDay" : 21,
"startASAP" : false
}
Give Feedback