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 Region management API

The Region management API from YugabyteDB — 5 operation(s) for region management.

This API exposes 7 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, /.

7 operations 5 paths 16 schemas 1 DELETE2 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 Region management 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 7

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

Region management 7
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions
Create a new region
createProviderRegion 3 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/provider_regions/{rUUID}
Modify a region
editProviderRegion 4 params body → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/regions
List a provider's regions
getRegion 2 params → 200500
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/regionsdeprecated
Create Region - deprecated
createRegion 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}
Delete a region
deleteRegion 4 params → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/regions/{rUUID}deprecated
Edit regions - deprecated
editRegion 4 params body → 200
GET
/api/v1/customers/{cUUID}/regions
List regions for all providers
listAllRegions 1 param → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are KubernetesRegionInfo (22 properties), Region_2 (12 properties), Region (12 properties), RegionFormData (10 properties). Each schema is shown below with its type and property counts.

Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 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
RegionDetails
object
1 property
GCPRegionCloudInfo
object
2 properties
YBPError
object
Generic error response from the YugabyteDB Anywhere API
6 properties
RegionFormData
object
10 properties 10 required
AzureRegionCloudInfo
object
5 properties
AWSRegionCloudInfo
object
4 properties
RegionCloudInfo
object
4 properties
RegionFormData_2
object
8 properties 8 required
AvailabilityZone_2
object
Availability zone (AZ) for a region
8 properties 1 required
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
YBPError_2
object
Generic error response from the YugabyteDB Anywhere API
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-region-management-api-openapi.yml Raw ↑
Where this information came from

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