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 Runtime configuration API

The Runtime configuration API from YugabyteDB — 6 operation(s) for runtime configuration.

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

Requests are made against a single base URL, /.

8 operations 6 paths 22 schemas 1 DELETE6 GET1 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 Runtime 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 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
List configuration scopes
listScopes 2 params → 200
GET
/api/v1/customers/{cUUID}/runtime_config/{scope}
List configuration entries for a scope
getConfig 4 params → 200
DELETE
/api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}
Delete a configuration key
deleteKey 4 params → 200
GET
/api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}
Get a configuration key
getConfigurationKey 4 params → 200
PUT
/api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}
Update a configuration key
setKey 4 params body → 200
GET
/api/v1/runtime_config/feature_flags
List all the feature flag runtime config keys and their values.
listFeatureFlags → 200
GET
/api/v1/runtime_config/mutable_key_info
List mutable keys
listKeyInfo → 200
GET
/api/v1/runtime_config/mutable_keys
List mutable keys
listKeys → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ConfKeyInfo_2 (6 properties), ConfKeyInfo_3 (6 properties), ConfKeyInfo (6 properties), ScopedConfig (4 properties). Each schema is shown below with its type and property counts.

ScopedConfig
object
Scoped configuration
4 properties
ConfDataTypeObject
object
1 property 1 required
ConfKeyInfo
object
6 properties 6 required
ConfigEntry
object
Configuration entry
3 properties
YBPSuccess
object
2 properties
RuntimeConfigData
object
Runtime configuration data
1 property
ScopedConfig_2
object
Scoped configuration
4 properties
ConfigEntry_2
object
Configuration entry
3 properties
YBPSuccess_2
object
2 properties
RuntimeConfigData_2
object
Runtime configuration data
1 property
ScopedConfig_3
object
Scoped configuration
4 properties
ConfDataTypeObject_2
object
1 property 1 required
ConfKeyInfo_2
object
6 properties 6 required
ConfigEntry_3
object
Configuration entry
3 properties
YBPSuccess_3
object
2 properties
RuntimeConfigData_3
object
Runtime configuration data
1 property
ScopedConfig_4
object
Scoped configuration
4 properties
ConfDataTypeObject_3
object
1 property 1 required
ConfKeyInfo_3
object
6 properties 6 required
ConfigEntry_4
object
Configuration entry
3 properties
YBPSuccess_4
object
2 properties
RuntimeConfigData_4
object
Runtime configuration data
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-runtime-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 Runtime 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.