Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

YugabyteDB

YugabyteDB Cloud providers API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

YugabyteDB Cloud providers API is one of 73 APIs that YugabyteDB 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 58 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.

11 operations 8 paths 58 schemas 1 DELETE4 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
HTTP Bearer
Contact
Yugabyte Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

YugabyteDB Cloud providers 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 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
YugabyteDB Anywhere List Cloud Providers
getListOfProviders 3 params → 200
POST
/api/v1/customers/{cUUID}/providers
YugabyteDB Anywhere Create a Provider
createProviders 4 params body → 200
GET
/api/v1/customers/{cUUID}/providers/region_metadata/{code}
YugabyteDB Anywhere Retrieves the Region Metadata for the Cloud Providers
getRegionMetadata 3 params → 200
DELETE
/api/v1/customers/{cUUID}/providers/{pUUID}
YugabyteDB Anywhere Delete a Cloud Provider
delete 3 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}
YugabyteDB Anywhere Get a Cloud Provider
getProvider 2 params → 200
POST
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation
YugabyteDB Anywhere Rotate Access Key for a Provider
accessKeyRotation 3 params → 200
GET
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule
YugabyteDB Anywhere 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
YugabyteDB Anywhere Rotate Access Key for a Provider - Scheduled
scheduledAccessKeyRotation 3 params → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/access_key_rotation/schedule/{sUUID}
YugabyteDB Anywhere Edit a Access Key Rotation Schedule
editAccessKeyRotationSchedule 4 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/edit
YugabyteDB Anywhere Update a Provider
editProvider 5 params body → 200
PUT
/api/v1/customers/{cUUID}/providers/{pUUID}/refresh_pricing
YugabyteDB Anywhere Refresh Provider Pricing Info
refreshPricing 3 params → 200

Schemas 58

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

AvailabilityZone
object
Availability zone (AZ) for a region
9 properties 1 required
ImageBundleDetails
object
6 properties
OnPremCloudInfo
object
2 properties
AWSCloudInfo
object
8 properties
AZCloudInfo
object
1 property
EditAccessKeyRotationScheduleParams
object
2 properties
YBPTask
object
2 properties
AzureCloudInfo
object
9 properties
AccessKeyId
object
2 properties
AWSRegionCloudInfo
object
4 properties
RegionDetails
object
1 property
YBPSuccess
object
2 properties
AvailabilityZoneDetails
object
1 property
BundleInfo
object
3 properties
AccessKey
object
Access key for the cloud provider. This helps to authenticate the user and get access to the provider.
4 properties 2 required
AzureRegionCloudInfo
object
5 properties
RegionMetadataInfo
object
4 properties 4 required
KubernetesInfo
object
13 properties 1 required
GCPCloudInfo
object
10 properties
GCPRegionCloudInfo
object
2 properties
KeyInfo
object
21 properties
RegionCloudInfo
object
4 properties
ImageBundle
object
6 properties
Region
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
Provider
object
22 properties 2 required
ProviderDetails
object
14 properties
RegionMetadata
object
1 property 1 required
CloudInfo
object
6 properties
Metadata
object
2 properties 2 required
KubernetesRegionInfo
object
22 properties 1 required
LocalCloudInfo
object
5 properties 5 required
Schedule
object
Backup schedule
17 properties 1 required
AvailabilityZone_2
object
Availability zone (AZ) for a region
9 properties 1 required
ImageBundleDetails_2
object
6 properties
OnPremCloudInfo_2
object
2 properties
AWSCloudInfo_2
object
8 properties
EditAccessKeyRotationScheduleParams_2
object
2 properties
YBPTask_2
object
2 properties
AzureCloudInfo_2
object
9 properties
AccessKeyId_2
object
2 properties
AWSRegionCloudInfo_2
object
4 properties
YBPSuccess_2
object
2 properties
BundleInfo_2
object
3 properties
AzureRegionCloudInfo_2
object
5 properties
RegionMetadataInfo_2
object
4 properties 4 required
KubernetesInfo_2
object
13 properties 1 required
GCPCloudInfo_2
object
10 properties
GCPRegionCloudInfo_2
object
2 properties
KeyInfo_2
object
21 properties
ImageBundle_2
object
6 properties
Region_2
object
Region within a given provider. Typically, this maps to a single cloud provider region.
12 properties 1 required
Provider_2
object
22 properties 2 required
ProviderDetails_2
object
14 properties
RegionMetadata_2
object
1 property 1 required
Metadata_2
object
2 properties 2 required
KubernetesRegionInfo_2
object
22 properties 1 required
LocalCloudInfo_2
object
5 properties 5 required
Schedule_2
object
Backup schedule
17 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
AE Profile APIs.io
YugabyteDB Accounts API
AE Profile APIs.io
YugabyteDB Alerts API
AE Profile APIs.io
YugabyteDB AllowLists API
AE Profile APIs.io
YugabyteDB Asynchronous Replication API
AE Profile APIs.io
YugabyteDB Audit API
AE Profile APIs.io
YugabyteDB Authentication API
AE Profile APIs.io
YugabyteDB Availability Zones API
AE Profile APIs.io
YugabyteDB Backup and Restore API
AE Profile APIs.io
YugabyteDB Backups API
AE Profile APIs.io
YugabyteDB Certificate Info API
AE Profile APIs.io
YugabyteDB Clusters API
AE Profile APIs.io
#Cloud providers
← Back to Y APIs
API Details
ID
yugabytedb:yugabytedb-cloud-providers-api
Base URL
https://cloud.yugabyte.com/api/public/v1
Docs
https://docs.yugabyte.com/stable/yugabyte-cloud/managed-automation/managed-api/
Provider
YugabyteDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network