Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager Administration API Resources
/
Measurements and Alerts
/
Maintenance Windows

Update One Maintenance Window

On this page

  • Required Roles
  • Request
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response
  • Response Header
  • Response Body

Update one maintenance window with an end date in the future.

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

PATCH /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 update.

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

THe request body must include at least one of the following fields:

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

1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2     --header "Accept: application/json" \
3     --header "Content-Type: application/json" \
4     --include \
5     --request PATCH "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/maintenanceWindows/{MW-ID}" \
6     --data '
7       {
8         "alertTypeNames" : [ "HOST", "REPLICA_SET" ]
9       }'

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

Back

Create One Maintenance Window

Next

Delete One Maintenance Window