LinuxCommandLibrary

doctl-databases-maintenance-window

Manage DigitalOcean database maintenance windows

TLDR

Run a doctl databases maintenance-window command with an access token

$ doctl [[d|databases]] [[mw|maintenance-window]] [command] [[-t|--access-token]] [access_token]
copy

Retrieve details about a database cluster's maintenance windows
$ doctl [[d|databases]] [[mw|maintenance-window]] [[g|get]] [database_id]
copy

Update the maintenance window for a database cluster
$ doctl [[d|databases]] [[mw|maintenance-window]] [[u|update]] [database_id] --day [day_of_the_week] --hour [hour_in_24_hours_format]
copy

SYNOPSIS

doctl databases maintenance-window get <cluster-id>
doctl databases maintenance-window update <cluster-id> [--day <day>] [--hour <hour>]

PARAMETERS

<cluster-id>
    Unique ID of the target database cluster

get
    Retrieve current maintenance window details

update
    Update the maintenance window day and/or hour

--day <day>
    Day of week: sunday, monday, tuesday, wednesday, thursday, friday, saturday

--hour <hour>
    UTC hour (00-23) formatted as two digits

--help, -h
    Display help for maintenance-window

DESCRIPTION

The doctl databases maintenance-window command manages scheduled maintenance windows for DigitalOcean Managed Databases clusters. It supports retrieving the current window or updating it to specify a preferred day and UTC hour for non-emergency maintenance, such as OS patches or node replacements.

Maintenance occurs weekly during the set window, minimizing impact on applications. DigitalOcean notifies via email before changes. Use get to view details like day, hour, and pending status. Use update to adjust—both day and hour must be provided, taking effect within 24 hours.

Cluster ID is required, obtained via doctl databases list. Authentication requires a DigitalOcean API token set via doctl auth init. Ideal for production setups aligning maintenance with off-peak hours. Only owners or those with database:write scope can update.

CAVEATS

Both --day and --hour required for update; changes apply within 24h.
Random default if unset. Non-emergency only; emergencies ignore window.

EXAMPLES

doctl databases maintenance-window get 9cc6d7f5-f2bf-4e86-b0e1-4dcee940eade
doctl databases maintenance-window update 9cc6d7f5-f2bf-4e86-b0e1-4dcee940eade --day monday --hour 03

REQUIREMENTS

doctl ≥1.10.0; API token with databases:read/write scopes.

SEE ALSO

Copied to clipboard