YugabyteDB website screenshot

YugabyteDB

YugabyteDB is a distributed PostgreSQL-compatible SQL database for cloud-native and mission-critical applications. It is delivered as open-source YugabyteDB Core, the fully managed YugabyteDB Aeon DBaaS, and the self-managed YugabyteDB Anywhere control plane, with REST APIs for programmatic management of accounts, projects, clusters, universes, backups, restores, read replicas, allow lists, and maintenance windows.

YugabyteDB publishes 2 APIs on the APIs.io network: Aeon REST API and Anywhere REST API. Tagged areas include Cloud Database, Database, DBaaS, Distributed SQL, and PostgreSQL.

The YugabyteDB catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

YugabyteDB’s developer surface includes authentication, documentation, API reference, getting-started guide, developer console, signup flow, pricing, and 81 more developer resources.

🌐 Visit website 📡 Source on GitHub
73.0/100 exemplar ▬ flat Agent 71/100 agent native Full breakdown ↓
scored 2026-07-20 · rubric v0.4
2 APIs 5 Agent Skills 10 Features
Cloud DatabaseDatabaseDBaaSDistributed SQLPostgreSQL

API Rating

API Evangelist API Evangelist Rating How this is scored →
scored 2026-07-20 · rubric v0.4
Composite quality — 73.0/100 · exemplar
Contract Quality 13.2 / 25
Developer Ergonomics 16.1 / 20
Commercial Clarity 20.0 / 20
Operational Transparency 8.9 / 13
Governance 8.8 / 12
Discoverability 6.0 / 10
Agent readiness — 71/100 · agent native
Machine-Readable Contract 18 / 18
Agentic Access Contract 15 / 15
MCP Server 12 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 5 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/yugabytedb: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs

YugabyteDB Aeon REST API

The YugabyteDB Aeon REST API provides programmatic access to the fully managed YugabyteDB cloud database service. It is used to deploy and manage clusters and read replicas, sch...

YugabyteDB Anywhere REST API

The YugabyteDB Anywhere REST API enables programmatic management of self-managed YugabyteDB deployments through the YugabyteDB Anywhere (YBA) control plane. It supports creating...

Agent Skills

explain-plan-analyzer

AGENT SKILL

operator

AGENT SKILL

yba-api

AGENT SKILL

ycql

AGENT SKILL

ysql

AGENT SKILL

Collections

YugabyteDB Aeon REST API

OPEN

Arazzo Workflows

YugabyteDB Aeon Add Read Replica

Add a read replica to a cluster and confirm it becomes ACTIVE.

ARAZZO

YugabyteDB Aeon Backup and Restore

Take an on-demand backup, poll until it succeeds, then restore the cluster from it.

ARAZZO

YugabyteDB Aeon Configure IP Allow List

Create an IP allow list in a project and confirm its CIDR entries.

ARAZZO

YugabyteDB Aeon Configure Maintenance Window

Read the current maintenance window for a cluster, then update its schedule.

ARAZZO

YugabyteDB Aeon Discover Account Clusters

Resolve the active account and project, then enumerate the clusters within it.

ARAZZO

YugabyteDB Aeon Pause or Resume Cluster

Pause or resume a cluster to control compute billing, then confirm the new state.

ARAZZO

YugabyteDB Aeon Provision Cluster

Create a cluster, poll until it becomes ACTIVE, then read its connection endpoints.

ARAZZO

YugabyteDB Aeon Scale Cluster

Read a cluster, submit an updated specification, and poll until it returns to ACTIVE.

ARAZZO

Pricing Plans

Yugabytedb Plans Pricing

3 plans

PLANS

Rate Limits

Yugabytedb Rate Limits

5 limits

RATE LIMITS

Scroll for all 8

FinOps

Yugabytedb Finops

FINOPS

Features

PostgreSQL Compatibility

Wire-compatible YSQL API supporting PostgreSQL drivers, ORMs, stored procedures, triggers, and extensions.

Distributed SQL

ACID transactions, automatic sharding, and horizontal scaling across nodes, zones, and regions.

Multi-Region Deployments

Geo-distributed clusters with synchronous and asynchronous replication for disaster recovery and data residency.

Cloud Database as a Service

Fully managed YugabyteDB Aeon clusters across AWS, Azure, and Google Cloud regions.

Self-Managed Control Plane

YugabyteDB Anywhere for deploying and operating universes on customer infrastructure and Kubernetes.

Backups and Restores

On-demand and scheduled backups, point-in-time recovery, and cross-region restore.

Read Replicas

Asynchronous read replicas for low-latency reads in additional regions.

Vector Indexing

Vector search capabilities for retrieval-augmented generation (RAG) and GenAI workloads.

YCQL API

Cassandra-compatible API for wide-column workloads alongside the PostgreSQL-compatible YSQL API.

Connection Management

Built-in connection pooling and load balancing for distributed workloads.

Use Cases

Database Modernization

Replace legacy monolithic RDBMS systems with a horizontally scalable, PostgreSQL-compatible alternative.

Cloud-Native Applications

Power Kubernetes-deployed and microservices applications with a resilient distributed SQL backend.

Multi-Region SaaS

Operate global SaaS platforms with low-latency reads and disaster-recovery-ready writes.

Financial Services

Run mission-critical transaction systems requiring strong consistency and high availability.

Retail and eCommerce

Handle high-throughput product catalogs, inventory, and orders across regions.

Telecommunications

Support subscriber, billing, and session data at carrier scale.

GenAI and RAG

Store embeddings and metadata for retrieval-augmented generation pipelines.

Edge and Streaming

Provide a durable distributed SQL store for edge and streaming application data.

Integrations

Kubernetes

Helm charts and a Kubernetes Operator for deploying YugabyteDB on Kubernetes clusters.

Terraform

Terraform Provider for YugabyteDB Anywhere for infrastructure-as-code management of universes.

YugabyteDB Voyager

Open-source migration tool for moving schema and data from PostgreSQL, Oracle, and MySQL to YugabyteDB.

AWS, Azure, and Google Cloud

Native deployment targets for YugabyteDB Aeon and Anywhere across major public clouds.

PostgreSQL Drivers and ORMs

Compatibility with standard PostgreSQL drivers, ORMs, and tooling via the YSQL API.

REST API

Bearer-token authenticated REST APIs for both Aeon and Anywhere control planes.

Solutions

YugabyteDB Core

Open-source distributed SQL database available under the Apache 2.0 license.

YugabyteDB Aeon

Fully managed cloud database service operated by Yugabyte.

YugabyteDB Anywhere

Self-managed control plane for operating YugabyteDB universes on customer infrastructure.

YugabyteDB Voyager

Database migration service and tooling for moving to YugabyteDB.

Semantic Vocabularies

Yugabytedb Context

0 classes · 15 properties

JSON-LD

API Governance Rules

YugabyteDB API Rules

6 rules · 5 warnings 1 info

SPECTRAL

YugabyteDB API Rules

73 rules · 17 errors 35 warnings 21 info

SPECTRAL

Kubernetes CRDs

yugabytedb backup schedule

CRD

yugabytedb backup

CRD

yugabytedb dr config

CRD

yugabytedb pitr config

CRD

yugabytedb release

CRD

yugabytedb restore job

CRD

yugabytedb storage config

CRD

yugabytedb support bundle

CRD

yugabytedb ybcertificate

CRD

yugabytedb ybplatform

CRD

yugabytedb ybprovider

CRD

yugabytedb ybuniverse

CRD

Resources

Get Started 5

Portal, sign-up, and the first successful call

GettingStarted
GettingStarted
 GettingStarted
GettingStarted
 Console
Console
 Signup
Signup
 Login
Login

Documentation 3

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference
 JSONSchema
JSONSchema

Agent Surfaces 4

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess
 MCPServer
MCPServer
 AgentSkills
AgentSkills
 LlmsText
LlmsText

Design & Contract 9

Pagination, idempotency, versioning, errors, and events

Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 JSONLD
JSONLD

Scroll for all 9

Build 48

SDKs, sample code, and the tooling you integrate with

GitHubOrganization
GitHubOrganization
 GitHubRepository
GitHubRepository
 MCP Server
SDKs
 AI Agent Skills
SDKs
 Java YSQL Smart Driver
SDKs
 Go YSQL Smart Driver
SDKs
 Python Django Backend
SDKs
 Python SQLAlchemy Dialect
SDKs
 Ruby ActiveRecord Adapter
SDKs
 Node.js Sequelize Package
SDKs
 Go GORM Driver
SDKs
 Java R2DBC YSQL Driver
SDKs
 Python LangChain Integration
SDKs
 C++ YCQL Driver
SDKs
 Java YCQL Driver
SDKs
 Python YCQL Driver
SDKs
 Node.js YCQL Driver
SDKs
 C# YCQL Driver
SDKs
 Go YCQL Driver
SDKs
 Java Spring Data Module
SDKs
 Database Migration Tool (yb-voyager)
CLI
 YCQL Shell (cqlsh)
CLI
 GitHubRepository
GitHubRepository
 GitHubRepository
GitHubRepository
 GitHubRepository
GitHubRepository
 GitHubRepository
GitHubRepository
 GitHubRepository
GitHubRepository
 GitHubRepository
GitHubRepository
 Workload Generator (Java)
CodeExamples
 Blog Demonstrations
CodeExamples
 CDC Connector Examples
CodeExamples
 Spring Boot Samples
CodeExamples
 Spring Data Sample
CodeExamples
 Microservices Demo (Hipster Shop fork)
CodeExamples
 Yugastore E-Commerce App
CodeExamples
 IoT Fleet Management Sample
CodeExamples
 ORM Examples
CodeExamples
 Workload Simulator
CodeExamples
 Helm Charts
SDKs
 Terraform AWS Module
SDKs
 Terraform Azure Module
SDKs
 Terraform GCP Module
SDKs
 AWS CloudFormation Template
SDKs
 Azure Resource Manager Template
SDKs
 GCP Deployment Manager
SDKs
 Flyway Plugin
SDKs
 HashiCorp Vault Plugin
SDKs
 GitHubRepository
GitHubRepository

Scroll for all 48

Access & Security 4

Authentication, authorization, and security posture

TrustCenter
TrustCenter
 DomainSecurity
DomainSecurity
 Authentication
Authentication
 Compliance
Compliance

Learn 4

Tutorials, courses, talks, and written guidance

Academy
Academy
 YouTube
YouTube
 Distributed SQL Lessons
Tutorials
 Code Labs
Tutorials

Operate 5

Status, limits, changes, and where to get help

StatusPage
StatusPage
 Support
Support
 Support
Support
 ReleaseNotes
ReleaseNotes
 StackOverflow
StackOverflow

Commercial 3

Pricing, plans, and the legal terms of use

Pricing
Pricing
 TermsOfService
TermsOfService
 PrivacyPolicy
PrivacyPolicy

Company 3

The organization behind the API

LinkedIn
LinkedIn
 Website
Website
 Blog
Blog

Source (apis.yml)

apis.yml Raw ↑ 
opencollection: 1.0.0
info:
  name: YugabyteDB Aeon REST API
  version: v1
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Accounts
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon List Accounts
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts
    docs: Returns a list of YugabyteDB Aeon accounts accessible to the authenticated API key holder. Most users have a single
      account.
  - info:
      name: YugabyteDB Aeon Get Account
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
    docs: Returns metadata for a specific YugabyteDB Aeon account, including the account ID used to scope project and cluster
      API calls.
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon List Projects
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
    docs: Returns all projects within the specified account. Projects group clusters and resources for organizational or billing
      purposes.
- info:
    name: Clusters
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon List Clusters
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
    docs: Returns all clusters within the specified account and project. Each cluster entry includes configuration, state,
      cloud provider, region placement, and endpoint information.
  - info:
      name: YugabyteDB Aeon Create Cluster
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      body:
        type: json
        data: '{}'
    docs: Creates a new YugabyteDB Aeon cluster within the specified account and project. The request body defines the cluster
      name, cloud provider, region, tier, node configuration, and fault tolerance level.
  - info:
      name: YugabyteDB Aeon Get Cluster
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Returns detailed information about a specific cluster, including its current state, configuration, cloud provider,
      region, node count, and connection endpoints.
  - info:
      name: YugabyteDB Aeon Update Cluster
      type: http
    http:
      method: PUT
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
      body:
        type: json
        data: '{}'
    docs: Updates the configuration of an existing cluster, such as scaling node count, changing disk size, or modifying fault
      tolerance settings.
  - info:
      name: YugabyteDB Aeon Delete Cluster
      type: http
    http:
      method: DELETE
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Permanently deletes the specified cluster and all its data. This operation is irreversible. All backups associated
      with the cluster are also deleted.
  - info:
      name: YugabyteDB Aeon Pause Cluster
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/pause
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Pauses a running cluster to suspend compute billing while retaining all data and configuration. The cluster can
      be resumed at any time. Only clusters in the ACTIVE state can be paused.
  - info:
      name: YugabyteDB Aeon Resume Cluster
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/resume
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Resumes a previously paused cluster, restoring it to the ACTIVE state and resuming compute billing. The cluster
      restores all data and configuration from before the pause.
- info:
    name: ReadReplicas
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon List Read Replicas
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/read-replicas
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Returns all read replicas configured for the specified cluster. Read replicas allow routing read traffic to geographically
      distributed nodes to reduce latency for remote clients.
  - info:
      name: YugabyteDB Aeon Create Read Replica
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/read-replicas
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
      body:
        type: json
        data: '{}'
    docs: Adds a read replica to the specified cluster in the configured cloud region. Read replicas serve read-only traffic
      and are asynchronously replicated from the primary cluster.
  - info:
      name: YugabyteDB Aeon Delete Read Replica
      type: http
    http:
      method: DELETE
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/read-replicas
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Removes all read replicas from the specified cluster. This operation is irreversible and immediately terminates
      read replica nodes.
- info:
    name: Backups
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon List Backups
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/backups
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Returns all backups for the specified cluster, including both scheduled and on-demand backups. Each entry includes
      backup state, creation time, expiry time, and size information.
  - info:
      name: YugabyteDB Aeon Create On-demand Backup
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/backups
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
      body:
        type: json
        data: '{}'
    docs: Triggers an immediate on-demand backup of the specified cluster. The backup is a full cluster snapshot stored in
      the same region as the cluster. Retention period can be specified in days.
- info:
    name: Restores
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon Restore from Backup
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/backups/:backupId/restore
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
      - name: backupId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the backup snapshot.
    docs: Restores the specified cluster from a previously created backup. The restore operation overwrites the current cluster
      data with the state captured in the backup snapshot.
- info:
    name: AllowLists
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon List Allow Lists
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/allow-lists
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
    docs: Returns all IP allow lists defined within the specified project. Allow lists control which IP addresses or CIDR
      ranges are permitted to connect to clusters in the project.
  - info:
      name: YugabyteDB Aeon Create Allow List
      type: http
    http:
      method: POST
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/allow-lists
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      body:
        type: json
        data: '{}'
    docs: Creates a new IP allow list with one or more CIDR entries. The allow list can be assigned to one or more clusters
      to permit inbound connections from the specified IP ranges.
  - info:
      name: YugabyteDB Aeon Get Allow List
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/allow-lists/:allowListId
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: allowListId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the IP allow list.
    docs: Returns details for a specific IP allow list, including its name, description, and all CIDR entries it contains.
  - info:
      name: YugabyteDB Aeon Delete Allow List
      type: http
    http:
      method: DELETE
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/allow-lists/:allowListId
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: allowListId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the IP allow list.
    docs: Permanently deletes the specified IP allow list. The allow list must not be currently assigned to any cluster before
      it can be deleted.
- info:
    name: MaintenanceWindows
    type: folder
  items:
  - info:
      name: YugabyteDB Aeon Get Maintenance Window
      type: http
    http:
      method: GET
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/maintenance-windows
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
    docs: Returns the configured maintenance window for the specified cluster, including the scheduled day of week and start
      hour for Yugabyte to apply patches and infrastructure updates.
  - info:
      name: YugabyteDB Aeon Update Maintenance Window
      type: http
    http:
      method: PUT
      url: https://cloud.yugabyte.com/api/public/v1/accounts/:accountId/projects/:projectId/clusters/:clusterId/maintenance-windows
      params:
      - name: accountId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the YugabyteDB Aeon account.
      - name: projectId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the project within the account.
      - name: clusterId
        value: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        type: path
        description: The unique identifier of the cluster.
      body:
        type: json
        data: '{}'
    docs: Updates the maintenance window schedule for the specified cluster. Setting a maintenance window allows operators
      to control when Yugabyte applies updates to minimize disruption.
bundled: true