Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas maintenanceWindows defer

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output
  • Examples

Defer scheduled maintenance for your project for one week.

To learn more about maintenance windows, see https://www.mongodb.com/docs/atlas/tutorial/cluster-maintenance-window/.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas maintenanceWindows defer [options]
Name
Type
Required
Description
-h, --help
false
help for defer
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
Name
Type
Required
Description
-P, --profile
string
false

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

Maintenance window deferred.
# Defer scheduled maintenance for one week for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas maintenanceWindows defer --projectId 5e2211c17a3e5a48f5497de3 --output json
← clear