Navigation

Update One Maintenance Window

On this page

Warning

Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.

Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.

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

Resource

copy 
PATCH /groups/{GROUP-ID}/maintenanceWindow

Request Path Parameters

Name Type Description
GROUP-ID string Unique identifier of the project from which you want to retrieve the Maintenance Window.

Request Query Parameters

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

Name Type Description Default
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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, response body includes:

status HTTP response code
envelope The expected 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.

  

Request Body Parameters

Note

If you set startASAP, all other body parameters are ignored.

Name Type Description
dayOfWeek integer

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

Day of Week Integer
Sunday 1
Monday 2
Tuesday 3
Wednesday 4
Thursday 5
Friday 6
Saturday 7
hourOfDay integer Hour 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.
startASAP boolean Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.
numberOfDeferrals integer Number of times the current maintenance event for this project has been deferred.
Name Type Description
startASAP boolean Flag indicating that the maintenance window should start immediately upon receiving this request.

Response

Name Type Description
dayOfWeek integer

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

Day of Week Integer
Sunday 1
Monday 2
Tuesday 3
Wednesday 4
Thursday 5
Friday 6
Saturday 7
hourOfDay integer Hour 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.
startASAP boolean Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.
numberOfDeferrals integer Number of times the current maintenance event for this project has been deferred.

This endpoint returns an empty JSON Object.

Example Request

copy 
curl --user "{USERNAME}:{APIKEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/ groups/{GROUP-ID}/maintenanceWindow?pretty=true" \
 --data '
 {
   "dayOfWeek" : 1,
   "hourOfDay" : 12
 }'
copy 
curl --user "{USERNAME}:{APIKEY}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://cloud.mongodb.com/api/atlas/v1.0/ groups/{GROUP-ID}/maintenanceWindow?pretty=true" \
 --data '
 {
   "startASAP" : true
 }'

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}

Response Body

This endpoint returns an empty JSON Object.

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