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

Yugabyte Maintenance Windows API

The Maintenance Windows API from Yugabyte — 5 operation(s) for maintenance windows.

Yugabyte Maintenance Windows API is one of 82 APIs that Yugabyte 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 8 operations across 5 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

8 operations 5 paths 9 schemas 1 DELETE2 GET3 POST2 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, HTTP Bearer
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 2

Yugabyte Maintenance Windows API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth). It accepts HTTP bearer tokens (bearerAuth).

  • apiKeyAuth — API token passed as header
  • bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization header.

Paths & Operations 8

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

Maintenance Windows 8
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
GET
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance-windows
YugabyteDB Aeon Get Maintenance Window
getMaintenanceWindow 3 params → 200401404
PUT
/accounts/{accountId}/projects/{projectId}/clusters/{clusterId}/maintenance-windows
YugabyteDB Aeon Update Maintenance Window
updateMaintenanceWindow 3 params body → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are MaintenanceWindow (10 properties), AlertConfigurationApiFilter (9 properties), MaintenanceWindowPagedApiQuery (6 properties), MaintenanceWindowPagedResponse (4 properties). Each schema is shown below with its type and property counts.

SuppressHealthCheckNotificationsConfig
object
2 properties
ErrorResponse
object
Standard error response returned by the API on failure.
1 property
MaintenanceWindowPagedApiQuery
object
6 properties 6 required
MaintenanceWindowApiFilter
object
2 properties 2 required
YBPSuccess
object
2 properties
AlertConfigurationApiFilter
object
9 properties
AlertConfigurationTarget
object
Alert target. Set to all, or specify one or more target UUIDs.
2 properties
MaintenanceWindow
object
Maintenance Window
10 properties 7 required
MaintenanceWindowPagedResponse
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte Backup Info API
Yugabyte Cluster API
Yugabyte Cluster Info API
Yugabyte Pitr Info API
Yugabyte Restore Info API
Yugabyte Voyager Info API
Yugabyte Voyager Metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API
Yugabyte Access Keys API
Yugabyte Accounts API
Where this information came from

This is an independent, third-party profile of Yugabyte 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.