How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Maintenance windows API

The Maintenance windows API from YugabyteDB — 4 operation(s) for maintenance windows.

YugabyteDB Maintenance windows API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Maintenance Windows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 6 operations across 4 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

6 operations 4 paths 31 schemas 1 DELETE1 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Maintenance windows API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Maintenance windows 6
POST
/api/v1/customers/{cUUID}/maintenance_windows
Create maintenance window
create 2 params body → 200
POST
/api/v1/customers/{cUUID}/maintenance_windows/list
List maintenance windows
listOfMaintenanceWindows 2 params body → 200
POST
/api/v1/customers/{cUUID}/maintenance_windows/page
List maintenance windows (paginated)
page 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}
Delete maintenance window
delete 3 params → 200
GET
/api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}
Get details of a maintenance window
get 2 params → 200
PUT
/api/v1/customers/{cUUID}/maintenance_windows/{windowUUID}
Update maintenance window
update 3 params body → 200

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are MaintenanceWindow (10 properties), MaintenanceWindow_3 (10 properties), MaintenanceWindow_4 (10 properties), AlertConfigurationApiFilter_4 (9 properties). Each schema is shown below with its type and property counts.

AlertConfigurationApiFilter
object
9 properties
MaintenanceWindowApiFilter
object
2 properties 2 required
AlertConfigurationTarget
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
MaintenanceWindowPagedApiQuery
object
6 properties 6 required
MaintenanceWindow
object
Maintenance Window
10 properties 7 required
SuppressHealthCheckNotificationsConfig
object
2 properties
YBPSuccess
object
2 properties
MaintenanceWindowPagedResponse
object
4 properties 4 required
AlertConfigurationApiFilter_2
object
9 properties 9 required
MaintenanceWindowApiFilter_2
object
2 properties 2 required
AlertConfigurationTarget_2
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
MaintenanceWindowPagedApiQuery_2
object
6 properties 6 required
MaintenanceWindow_2
object
Maintenance Window
9 properties 7 required
YBPSuccess_2
object
2 properties
MaintenanceWindowPagedResponse_2
object
4 properties 4 required
AlertConfigurationApiFilter_3
object
9 properties
MaintenanceWindowApiFilter_3
object
2 properties 2 required
AlertConfigurationTarget_3
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
MaintenanceWindowPagedApiQuery_3
object
6 properties 6 required
MaintenanceWindow_3
object
Maintenance Window
10 properties 7 required
SuppressHealthCheckNotificationsConfig_2
object
2 properties
YBPSuccess_3
object
2 properties
MaintenanceWindowPagedResponse_3
object
4 properties 4 required
AlertConfigurationApiFilter_4
object
9 properties
MaintenanceWindowApiFilter_4
object
2 properties 2 required
AlertConfigurationTarget_4
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
MaintenanceWindowPagedApiQuery_4
object
6 properties 6 required
MaintenanceWindow_4
object
Maintenance Window
10 properties 7 required
SuppressHealthCheckNotificationsConfig_3
object
2 properties
YBPSuccess_4
object
2 properties
MaintenanceWindowPagedResponse_4
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-maintenance-windows-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
Where this information came from

This is an independent, third-party profile of YugabyteDB Maintenance windows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.