Docs Menu
Docs Home
/ /

atlas api maintenanceWindows

Returns, edits, and removes maintenance windows.

The atlas api sub-command is automatically generated from the MongoDB Atlas Admin API and offers full coverage of the Admin API. Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.

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.

Name
Type
Required
Description

-h, --help

false

help for maintenanceWindows

Name
Type
Required
Description

-P, --profile

string

false

Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

  • atlas api maintenanceWindows deferMaintenanceWindow - Defers the maintenance window for the specified project.

  • atlas api maintenanceWindows getMaintenanceWindow - Returns the maintenance window for the specified project.

  • atlas api maintenanceWindows resetMaintenanceWindow - Resets the maintenance window for the specified project.

  • atlas api maintenanceWindows toggleMaintenanceAutoDefer - Toggles automatic deferral of the maintenance window for the specified project.

  • atlas api maintenanceWindows updateMaintenanceWindow - Updates the maintenance window for the specified project.

Back

updateLegacySnapshotSchedule

On this page