v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
MaintenanceSchedules

Get a maintenance schedule

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_database

OAuth Scopes

ResourceScopes
Organizationread_databases
Databaseread_database
get/organizations/{organization}/databases/{database}/maintenance-schedules/{id}

Path parameters

idstring required

The ID of the maintenance schedule

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

Response

Returns a maintenance schedule

idstring required

The ID of the maintenance schedule

namestring required

The display name of the maintenance schedule

created_atstring required

When the maintenance schedule was created

updated_atstring required

When the maintenance schedule was last updated

last_window_datetimestring required

When the last maintenance window started

next_window_datetimestring required

When the next maintenance window is scheduled

durationinteger required

The duration of the maintenance window in hours

dayinteger required

Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)

hourinteger required

Hour of the day in UTC (0-23)

weekinteger required

Week of the month for monthly schedules (0-3)

frequency_valueinteger required

The frequency value of the maintenance schedule

frequency_unit'day' | 'week' | 'month' | 'once' required

The frequency unit of the maintenance schedule

enabledboolean required

Whether the maintenance schedule is enabled

expires_atstring nullable required

When a one-time maintenance schedule expires

deadline_atstring nullable required

The deadline for a required maintenance schedule

requiredboolean required

Whether the maintenance schedule is required

pending_vitess_version_updateboolean required

Whether there is a pending Vitess version update

pending_vitess_versionstring nullable required

The pending Vitess version, if any

pending_mysql_version_updateboolean required

Whether there is a pending MySQL version update

pending_mysql_versionstring nullable required

The pending MySQL version, if any