YugabyteDB Runtime 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 Runtime 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
8 operations
across 6 paths,
and defines 12 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.
8 operations6 paths12 schemas1 DELETE6 GET1 PUT
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Runtime 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 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 6 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Runtime configuration 8
GET
/api/v1/customers/{cUUID}/runtime_config/scopes
YugabyteDB Anywhere List Configuration Scopes
listScopes2 params→ 200
GET
/api/v1/customers/{cUUID}/runtime_config/{scope}
YugabyteDB Anywhere List Configuration Entries for a Scope
YugabyteDB Anywhere List All the Feature Flag Runtime Config Keys and Their Values.
listFeatureFlags→ 200
GET
/api/v1/runtime_config/mutable_key_info
YugabyteDB Anywhere List Mutable Keys
listKeyInfo→ 200
GET
/api/v1/runtime_config/mutable_keys
YugabyteDB Anywhere List Mutable Keys
listKeys→ 200
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are ConfKeyInfo (6 properties), ConfKeyInfo_2 (6 properties), ScopedConfig (4 properties), ScopedConfig_2 (4 properties). Each schema is shown below with its type and property counts.
ConfDataTypeObject
object
1 property1 required
RuntimeConfigData
object
Runtime configuration data
1 property
YBPSuccess
object
2 properties
ScopedConfig
object
Scoped configuration
4 properties
ConfigEntry
object
Configuration entry
3 properties
ConfKeyInfo
object
6 properties6 required
ConfDataTypeObject_2
object
1 property1 required
RuntimeConfigData_2
object
Runtime configuration data
1 property
YBPSuccess_2
object
2 properties
ScopedConfig_2
object
Scoped configuration
4 properties
ConfigEntry_2
object
Configuration entry
3 properties
ConfKeyInfo_2
object
6 properties6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
