Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Create One Maintenance Window

On this page

Create one maintenance window. Ops Manager turns off alert notifications for certain alert types for a period of time you specify to allow maintenance to occur.

Required Roles

You can successfully call this endpoint with any of the following assigned roles:

Request

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

copy 
POST /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
envelope Expected response body
false

Request Body Parameters

Body Parameter Type Necessity Description
alertTypeNames array of strings Required Alert types to silence during maintenance window. For example: HOST, REPLICA_SET, CLUSTER, AGENT, BACKUP
startDate string Required Timestamp in ISO 8601 date and time format in UTC when the maintenance window starts.
endDate string Required Timestamp in ISO 8601 date and time format in UTC when the maintenance window ends.
description string Optional Description of the maintenance window.

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 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows" \
     --data '
       {
         "startDate" :"2015-10-23T22:00:00Z",
         "endDate" : "2015-10-23T23:30:00Z",
         "alertTypeNames" : [ "REPLICA_SET" ],
         "description" : "new description"
       }'

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
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "alertTypeNames" : [ "REPLICA_SET" ],
  "created" : "2015-10-22T20:49:35Z",
  "description" : "my description",
  "endDate" : "2015-10-23T23:30:00Z",
  "groupId" : "{PROJECT-ID}",
  "id" : "56294bdfd4c643eef5176b73",
  "startDate" : "2015-10-23T22:00:00Z",
  "updated" : "2015-10-22T20:49:35Z",
  "links" : []
}

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