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 Availability Zones API

The Availability Zones API from YugabyteDB — 4 operation(s) for availability zones.

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

Requests are made against a single base URL, /.

6 operations 4 paths 11 schemas 1 DELETE1 GET2 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
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Availability Zones 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, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Availability Zones 6
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones
Create an availability zone
createZone 4 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}/region_zones/{azUUID}
Modify an availability zone
editZone 5 params body → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones
List availability zones
listOfAZ 3 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zonesdeprecated
Create an availability zone - deprecated
createAZ 4 params body → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}
Delete an availability zone
deleteAZ 5 params → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}/zones/{azUUID}deprecated
Edit an Availabilty Zone - deprecated
editAZ 5 params body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are KubernetesRegionInfo (22 properties), AvailabilityZone (9 properties), AvailabilityZone_2 (8 properties), AvailabilityZoneData (4 properties). Each schema is shown below with its type and property counts.

AvailabilityZoneData
object
Details of an availability zone, used by the API and UI to validate data against input constraints
4 properties 2 required
AvailabilityZoneFormData
object
1 property 1 required
AvailabilityZoneDetails
object
1 property
AZCloudInfo
object
1 property
KubernetesRegionInfo
object
22 properties 1 required
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties 1 required
YBPSuccess
object
2 properties
AvailabilityZoneData_2
object
Details of an availability zone, used by the API and UI to validate data against input constraints
3 properties 2 required
AvailabilityZoneFormData_2
object
1 property 1 required
YBPSuccess_2
object
2 properties
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-availability-zones-api-openapi.yml Raw ↑
Where this information came from

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