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

Yugabyte Cloud Providers API

The Cloud Providers API from Yugabyte — 8 operation(s) for cloud providers.

Yugabyte Cloud Providers API is one of 82 APIs that Yugabyte publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cloud Providers. 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 11 operations across 8 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

11 operations 8 paths 32 schemas 1 DELETE4 GET3 POST3 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

Yugabyte Cloud Providers 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 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 4 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Cloud Providers 11
GET
/api/v1/customers/{cUUID}/providers
List cloud providers
getListOfProviders 3 params → 200
POST
/api/v1/customers/{cUUID}/providers
Create a provider
createProviders 4 params body → 200
GET
/api/v1/customers/{cUUID}/providers/region_metadata/{code}
Retrieves the region metadata for the cloud providers
getRegionMetadata 3 params → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}
Delete a cloud provider
delete 3 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}
Get a cloud provider
getProvider 2 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation
Rotate access key for a provider
accessKeyRotation 3 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule
List all schedules for a provider's access key rotation
listSchedules 2 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule
Rotate access key for a provider - Scheduled
scheduledAccessKeyRotation 3 params → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule/{sUUID}
Edit a access key rotation schedule
editAccessKeyRotationSchedule 4 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/edit
Update a provider
editProvider 5 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/refresh_pricing
Refresh provider pricing info
refreshPricing 3 params → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are KubernetesRegionInfo (22 properties), Provider (22 properties), KeyInfo (21 properties), Schedule (17 properties). Each schema is shown below with its type and property counts.

YBPTask
object
2 properties
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
RegionCloudInfo
object
4 properties
KeyInfo
object
21 properties
YBPSuccess
object
2 properties
AWSRegionCloudInfo
object
4 properties
GCPRegionCloudInfo
object
2 properties
RegionDetails
object
1 property
AvailabilityZone
object
Availability zone (AZ) for a region
9 properties 1 required
AccessKey
object
Access key for the cloud provider. This helps to authenticate the user and get access to the provider.
4 properties 2 required
ImageBundle
object
6 properties
AzureCloudInfo
object
9 properties
KubernetesRegionInfo
object
22 properties 1 required
LocalCloudInfo
object
5 properties 5 required
Metadata
object
2 properties 2 required
AzureRegionCloudInfo
object
5 properties
ImageBundleDetails
object
6 properties
KubernetesInfo
object
13 properties 1 required
RegionMetadata
object
1 property 1 required
AvailabilityZoneDetails
object
1 property
BundleInfo
object
3 properties
AccessKeyId
object
2 properties
CloudInfo
object
6 properties
EditAccessKeyRotationScheduleParams
object
2 properties
GCPCloudInfo
object
10 properties
OnPremCloudInfo
object
2 properties
AZCloudInfo
object
1 property
AWSCloudInfo
object
8 properties
Provider
object
22 properties 2 required
Schedule
object
Backup schedule
17 properties 1 required
RegionMetadataInfo
object
4 properties 4 required
ProviderDetails
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabyte-cloud-providers-api-openapi.yml Raw ↑

Other APIs Yugabyte publishes across the network.

YugabyteDB Aeon REST API
Yugabyte Backup Info API
Yugabyte Cluster API
Yugabyte Cluster Info API
Yugabyte Pitr Info API
Yugabyte Restore Info API
Yugabyte Voyager Info API
Yugabyte Voyager Metrics API
Yugabyte Xcluster Metrics API
Yugabyte Xcluster Namespace Details API
Yugabyte Access Keys API
Yugabyte Accounts API
Where this information came from

This is an independent, third-party profile of Yugabyte Cloud Providers 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.