YugabyteDB Customer Configuration API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Customer Configuration. 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
9 operations
across 7 paths,
and defines 9 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.
9 operations7 paths9 schemas2 DELETE2 GET2 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Customer Configuration 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 9
Across 7 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Customer Configuration 9
POST
/api/v1/customers/{cUUID}/cloud/{cloud}/buckets
YugabyteDB Anywhere List Buckets with Provided Credentials
listBuckets3 paramsbody→ 200
GET
/api/v1/customers/{cUUID}/configs
YugabyteDB Anywhere List All Customer Configurations
getListOfCustomerConfig1 param→ 200
POST
/api/v1/customers/{cUUID}/configs
YugabyteDB Anywhere Create a Customer Configuration
YugabyteDB Anywhere Update a Customer Configuration V2
editCustomerConfig3 paramsbody→ 200
PUT
/api/v1/customers/{cUUID}/api_token
Generate an API token for the current user
generateAPIToken2 params→ 200
Schemas 9
The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are CustomerConfigUI_2 (10 properties), CustomerConfigUI (10 properties), CustomerConfig_2 (8 properties), CustomerConfig (8 properties). Each schema is shown below with its type and property counts.
CustomerConfig
object
Customer configuration. Includes storage, alerts, password policy, and call-home level.
8 properties6 required
CustomerConfigUI
object
Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level.
10 properties6 required
UniverseDetailSubset
object
A small subset of universe information
6 properties6 required
CustomerConfigData
object
YBPTask
object
2 properties
CustomerConfig_2
object
Customer configuration. Includes storage, alerts, password policy, and call-home level.
8 properties6 required
CustomerConfigUI_2
object
Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level.
10 properties6 required
UniverseDetailSubset_2
object
A small subset of universe information
6 properties6 required
YBPTask_2
object
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
