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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Yugabytedb

YugabyteDB Maintenance windows API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 8 operations across 5 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

8 operations 5 paths 16 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
License
Polyform Free Trial License 1.0.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

YugabyteDB 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 16

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-maintenance-windows-api-openapi.yml Raw ↑
#Maintenance Windows
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-maintenance-windows-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
Yugabytedb
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=yugabytedb-maintenance-windows-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/yugabytedb-maintenance-windows-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

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.