Docs Menu
Docs Home
/ /
Atlas CLI
/ /

atlas maintenanceWindows describe

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output
  • Examples

Return the maintenance window details for your project.

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 Read Only role.

Command Syntax
atlas maintenanceWindows describe [options]
Name
Type
Required
Description
-h, --help
false
help for describe
-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.

DAY OF THE WEEK HOUR OF DAY START ASAP
<DayOfWeek> <HourOfDay> <StartASAP>
# Return the maintenance window for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas maintenanceWindows describe --projectId 5e2211c17a3e5a48f5497de3 --output json
← defer
update →