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 Customer Configuration API

The Customer Configuration API from YugabyteDB — 7 operation(s) for customer configuration.

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 19 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

9 operations 7 paths 19 schemas 2 DELETE2 GET2 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

YugabyteDB Customer Configuration 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 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
List buckets with provided credentials
listBuckets 3 params body → 200
GET
/api/v1/customers/{cUUID}/configs
List all customer configurations
getListOfCustomerConfig 1 param → 200
POST
/api/v1/customers/{cUUID}/configs
Create a customer configuration
createCustomerConfig 2 params body → 200
DELETE
/api/v1/customers/{cUUID}/configs/{configUUID}deprecated
Delete a customer configuration
deleteCustomerConfig 4 params → 200
PUT
/api/v1/customers/{cUUID}/configs/{configUUID}
Update a customer configuration
editCustomerConfig 3 params body → 200
GET
/api/v1/customers/{cUUID}/configs/{configUUID}/backup_dirs
List all backup dirs within a customer configurations
getListOfYbaBackupDirsCustomerConfig 2 params → 200
DELETE
/api/v1/customers/{cUUID}/configs/{configUUID}/delete
Delete a customer configuration V2
deleteCustomerConfigV2 4 params → 200
PUT
/api/v1/customers/{cUUID}/configs/{configUUID}/edit
Update a customer configuration V2
editCustomerConfig 3 params body → 200
PUT
/api/v1/customers/{cUUID}/api_token
Generate an API token for the current user
generateAPIToken 1 param body → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are CustomerConfigUI_3 (10 properties), CustomerConfigUI (10 properties), CustomerConfigUI_4 (10 properties), CustomerConfigUI_2 (9 properties). Each schema is shown below with its type and property counts.

CustomerConfigData
object
CustomerConfigUI
object
Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level.
10 properties 6 required
UniverseDetailSubset
object
A small subset of universe information
6 properties 6 required
CustomerConfig
object
Customer configuration. Includes storage, alerts, password policy, and call-home level.
8 properties 6 required
YBPTask
object
2 properties
CustomerConfigUI_2
object
Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level.
9 properties 5 required
DummyBody
object
Dummy value to work around platform bug PLAT-2076
1 property
UniverseDetailSubset_2
object
A small subset of universe information
6 properties 6 required
CustomerConfig_2
object
Customer configuration. Includes storage, alerts, password policy, and call-home level.
7 properties 5 required
SessionInfo
object
Session information
4 properties
YBPTask_2
object
2 properties
CustomerConfigUI_3
object
Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level.
10 properties 6 required
UniverseDetailSubset_3
object
A small subset of universe information
6 properties 6 required
CustomerConfig_3
object
Customer configuration. Includes storage, alerts, password policy, and call-home level.
8 properties 6 required
YBPTask_3
object
2 properties
CustomerConfigUI_4
object
Customer configuration with additional information. Includes storage, alerts, password policy, and call-home level.
10 properties 6 required
UniverseDetailSubset_4
object
A small subset of universe information
6 properties 6 required
CustomerConfig_4
object
Customer configuration. Includes storage, alerts, password policy, and call-home level.
8 properties 6 required
YBPTask_4
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-customer-configuration-api-openapi.yml Raw ↑

Other APIs YugabyteDB publishes across the network.

YugabyteDB Access Keys API
YugabyteDB Accounts API
YugabyteDB Alerts API
YugabyteDB AllowLists API
YugabyteDB Asynchronous Replication API
YugabyteDB Audit API
YugabyteDB Authentication API
YugabyteDB Availability Zones API
YugabyteDB Backup and Restore API
YugabyteDB Backups API
YugabyteDB Certificate Info API
YugabyteDB Cloud providers API
Where this information came from

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