YugabyteDB Availability Zones API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Availability Zones. 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 12 schemas.
It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.
6 operations4 paths12 schemas1 DELETE1 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Availability Zones API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
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 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.
YugabyteDB Anywhere Edit an Availabilty Zone - Deprecated
editAZ5 paramsbody→ 200
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are KubernetesRegionInfo (22 properties), KubernetesRegionInfo_2 (22 properties), AvailabilityZone_2 (9 properties), AvailabilityZone (9 properties). Each schema is shown below with its type and property counts.
AvailabilityZoneFormData
object
1 property1 required
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties1 required
YBPSuccess
object
2 properties
AvailabilityZoneDetails
object
1 property
AvailabilityZoneData
object
Details of an availability zone, used by the API and UI to validate data against input constraints
4 properties2 required
AZCloudInfo
object
1 property
KubernetesRegionInfo
object
22 properties1 required
AvailabilityZoneFormData_2
object
1 property1 required
AvailabilityZone_2
object
Availability zone (AZ) for a region
9 properties1 required
YBPSuccess_2
object
2 properties
AvailabilityZoneData_2
object
Details of an availability zone, used by the API and UI to validate data against input constraints
4 properties2 required
KubernetesRegionInfo_2
object
22 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
