How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Maintenance Windows API

Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per replica set. You can defer a scheduled maintenance event for a project up to two times. Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.

MongoDB Maintenance Windows API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Maintenance Windows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 5 operations across 3 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

5 operations 3 paths 5 schemas 1 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Maintenance Windows API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Maintenance Windows 5

Returns, edits, and removes maintenance windows. The maintenance procedure that MongoDB Cloud performs requires at least one replica set election during the maintenance window per…

DELETE
/api/atlas/v2/groups/{groupId}/maintenanceWindow
Reset One Maintenance Window for One Project
resetGroupMaintenanceWindow 2 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/maintenanceWindow
Return One Maintenance Window for One Project
getGroupMaintenanceWindow 3 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/maintenanceWindow
Update One Maintenance Window for One Project
updateGroupMaintenanceWindow 2 params body → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/maintenanceWindow/autoDefer
Toggle Automatic Deferral of Maintenance for One Project
toggleGroupMaintenanceWindowAutoDefer 2 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/maintenanceWindow/defer
Defer One Maintenance Window for One Project
deferGroupMaintenanceWindow 2 params → 200400401403404429500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are GroupMaintenanceWindow (7 properties), ApiError (6 properties), FieldViolation (2 properties), ProtectedHours (2 properties). Each schema is shown below with its type and property counts.

ProtectedHours
object
Defines the a window where maintenance will not begin within.
2 properties
FieldViolation
object
2 properties 2 required
BadRequestDetail
object
Bad request detail.
1 property
GroupMaintenanceWindow
object
7 properties 1 required
ApiError
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-maintenance-windows-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Maintenance Windows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.