YugabyteDB Runtime configuration API

openapi: 3.2.0
info:
  title: Yugabytedb Runtime configuration API
  version: v1
  contact:
    name: https://docs.yugabyte.com
  license:
    name: Polyform Free Trial License 1.0.0
    url: https://github.com/yugabyte/yugabyte-db/blob/master/licenses/POLYFORM-FREE-TRIAL-LICENSE-1.0.0.txt
  termsOfService: TODO(chirag)
  x-refined-note:
  - x-source differs across the merged source definitions and was not carried
  - x-split-from differs across the merged source definitions and was not carried
  description: 'Operations tagged Runtime configuration across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-releases-maintenance.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Runtime configuration
paths:
  /api/v1/customers/{cUUID}/runtime_config/scopes:
    get:
      description: Lists all (including empty scopes) runtime config scopes for current customer. List includes the Global scope that spans multiple customers, scope for customer specific overrides for current customer and one scope each for each universe and provider.
      operationId: listScopes
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuntimeConfigData'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List configuration scopes
      tags:
      - Runtime configuration
    servers:
    - url: /
  /api/v1/customers/{cUUID}/runtime_config/{scope}:
    get:
      description: Lists all runtime config entries for a given scope for current customer.
      operationId: getConfig
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: scope
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: includeInherited
        schema:
          default: false
          type: boolean
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScopedConfig'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List configuration entries for a scope
      tags:
      - Runtime configuration
    servers:
    - url: /
  /api/v1/customers/{cUUID}/runtime_config/{scope}/key/{key}:
    delete:
      operationId: deleteKey
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: scope
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: key
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Delete a configuration key
      tags:
      - Runtime configuration
    get:
      operationId: getConfigurationKey
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: scope
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: key
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            text/plain:
              schema:
                type: string
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get a configuration key
      tags:
      - Runtime configuration
    put:
      operationId: setKey
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: scope
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: key
        required: true
        schema:
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          text/plain:
            schema:
              type: string
        description: New value for config key
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPSuccess'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Update a configuration key
      tags:
      - Runtime configuration
      x-codegen-request-body-name: newValue
    servers:
    - url: /
  /api/v1/runtime_config/feature_flags:
    get:
      description: YbaApi Internal.
      operationId: listFeatureFlags
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ConfigEntry'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List all the feature flag runtime config keys and their values.
      tags:
      - Runtime configuration
    servers:
    - url: /
  /api/v1/runtime_config/mutable_key_info:
    get:
      description: List all the mutable runtime config keys with metadata
      operationId: listKeyInfo
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ConfKeyInfo'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List mutable keys
      tags:
      - Runtime configuration
    servers:
    - url: /
  /api/v1/runtime_config/mutable_keys:
    get:
      description: List all the mutable runtime config keys
      operationId: listKeys
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  type: string
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List mutable keys
      tags:
      - Runtime configuration
    servers:
    - url: /
components:
  schemas:
    ScopedConfig:
      description: Scoped configuration
      example:
        configEntries:
        - inherited: true
          value: value
          key: key
        - inherited: true
          value: value
          key: key
        mutableScope: true
        type: GLOBAL
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        configEntries:
          description: List of configurations
          items:
            $ref: '#/components/schemas/ConfigEntry'
          type: array
        mutableScope:
          description: Mutability of the scope. Only super admin users can change global scope; other scopes are customer-mutable.
          type: boolean
        type:
          description: Scope type
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
        uuid:
          description: Scope UIID
          format: uuid
          type: string
      type: object
    ConfDataTypeObject:
      example:
        name: name
      properties:
        name:
          type: string
      required:
      - name
      type: object
    ConfKeyInfo:
      example:
        displayName: displayName
        dataType:
          name: name
        scope: GLOBAL
        helpTxt: helpTxt
        key: key
        tags:
        - PUBLIC
        - PUBLIC
      properties:
        dataType:
          $ref: '#/components/schemas/ConfDataTypeObject'
        displayName:
          type: string
        helpTxt:
          type: string
        key:
          type: string
        scope:
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
        tags:
          items:
            enum:
            - PUBLIC
            - INTERNAL
            - FEATURE_FLAG
            type: string
          type: array
      required:
      - dataType
      - displayName
      - helpTxt
      - key
      - scope
      - tags
      type: object
    ConfigEntry:
      description: Configuration entry
      example:
        inherited: true
        value: value
        key: key
      properties:
        inherited:
          description: Is this configuration inherited?
          type: boolean
        key:
          description: Configuration key
          type: string
        value:
          description: Configuration value
          type: string
      type: object
    YBPSuccess:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    RuntimeConfigData:
      description: Runtime configuration data
      example:
        scopedConfigList:
        - configEntries:
          - inherited: true
            value: value
            key: key
          - inherited: true
            value: value
            key: key
          mutableScope: true
          type: GLOBAL
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - configEntries:
          - inherited: true
            value: value
            key: key
          - inherited: true
            value: value
            key: key
          mutableScope: true
          type: GLOBAL
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        scopedConfigList:
          description: List of scoped configurations
          items:
            $ref: '#/components/schemas/ScopedConfig'
          type: array
      type: object
    ScopedConfig_2:
      description: Scoped configuration
      properties:
        configEntries:
          description: List of configurations
          items:
            $ref: '#/components/schemas/ConfigEntry_2'
          type: array
        mutableScope:
          description: Mutability of the scope. Only super admin users can change global scope; other scopes are customer-mutable.
          type: boolean
        type:
          description: Scope type
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
        uuid:
          description: Scope UIID
          format: uuid
          type: string
      type: object
    ConfigEntry_2:
      description: Configuration entry
      properties:
        inherited:
          description: Is this configuration inherited?
          type: boolean
        key:
          description: Configuration key
          type: string
        value:
          description: Configuration value
          type: string
      type: object
    YBPSuccess_2:
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
      type: object
    RuntimeConfigData_2:
      description: Runtime configuration data
      properties:
        scopedConfigList:
          description: List of scoped configurations
          items:
            $ref: '#/components/schemas/ScopedConfig_2'
          type: array
      type: object
    ScopedConfig_3:
      description: Scoped configuration
      example:
        configEntries:
        - inherited: true
          value: value
          key: key
        - inherited: true
          value: value
          key: key
        mutableScope: true
        type: GLOBAL
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        configEntries:
          description: List of configurations
          items:
            $ref: '#/components/schemas/ConfigEntry_3'
          type: array
          example:
          - inherited: true
            value: value
            key: key
        mutableScope:
          description: Mutability of the scope. Only super admin users can change global scope; other scopes are customer-mutable.
          type: boolean
          example: true
        type:
          description: Scope type
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
          example: GLOBAL
        uuid:
          description: Scope UIID
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    ConfDataTypeObject_2:
      example:
        name: name
      properties:
        name:
          type: string
          example: example-name
      required:
      - name
      type: object
    ConfKeyInfo_2:
      example:
        displayName: displayName
        dataType:
          name: name
        scope: GLOBAL
        helpTxt: helpTxt
        key: key
        tags:
        - PUBLIC
        - PUBLIC
      properties:
        dataType:
          $ref: '#/components/schemas/ConfDataTypeObject_2'
        displayName:
          type: string
          example: example-displayName
        helpTxt:
          type: string
          example: example-helpTxt
        key:
          type: string
          example: example-key
        scope:
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
          example: GLOBAL
        tags:
          items:
            enum:
            - PUBLIC
            - INTERNAL
            - FEATURE_FLAG
            type: string
          type: array
          example:
          - PUBLIC
      required:
      - dataType
      - displayName
      - helpTxt
      - key
      - scope
      - tags
      type: object
    ConfigEntry_3:
      description: Configuration entry
      example:
        inherited: true
        value: value
        key: key
      properties:
        inherited:
          description: Is this configuration inherited?
          type: boolean
          example: true
        key:
          description: Configuration key
          type: string
          example: example-key
        value:
          description: Configuration value
          type: string
          example: example-value
      type: object
    YBPSuccess_3:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    RuntimeConfigData_3:
      description: Runtime configuration data
      example:
        scopedConfigList:
        - configEntries:
          - inherited: true
            value: value
            key: key
          - inherited: true
            value: value
            key: key
          mutableScope: true
          type: GLOBAL
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - configEntries:
          - inherited: true
            value: value
            key: key
          - inherited: true
            value: value
            key: key
          mutableScope: true
          type: GLOBAL
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        scopedConfigList:
          description: List of scoped configurations
          items:
            $ref: '#/components/schemas/ScopedConfig_3'
          type: array
          example:
          - configEntries:
            - inherited: true
              value: value
              key: key
            - inherited: true
              value: value
              key: key
            mutableScope: true
            type: GLOBAL
            uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    ScopedConfig_4:
      description: Scoped configuration
      example:
        configEntries:
        - inherited: true
          value: value
          key: key
        - inherited: true
          value: value
          key: key
        mutableScope: true
        type: GLOBAL
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        configEntries:
          description: List of configurations
          items:
            $ref: '#/components/schemas/ConfigEntry_4'
          type: array
          example:
          - inherited: true
            value: value
            key: key
        mutableScope:
          description: Mutability of the scope. Only super admin users can change global scope; other scopes are customer-mutable.
          type: boolean
          example: true
        type:
          description: Scope type
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
          example: GLOBAL
        uuid:
          description: Scope UIID
          format: uuid
          type: string
          example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
    ConfDataTypeObject_3:
      example:
        name: name
      properties:
        name:
          type: string
          example: example-name
      required:
      - name
      type: object
    ConfKeyInfo_3:
      example:
        displayName: displayName
        dataType:
          name: name
        scope: GLOBAL
        helpTxt: helpTxt
        key: key
        tags:
        - PUBLIC
        - PUBLIC
      properties:
        dataType:
          $ref: '#/components/schemas/ConfDataTypeObject_3'
        displayName:
          type: string
          example: example-displayName
        helpTxt:
          type: string
          example: example-helpTxt
        key:
          type: string
          example: example-key
        scope:
          enum:
          - GLOBAL
          - CUSTOMER
          - UNIVERSE
          - PROVIDER
          type: string
          example: GLOBAL
        tags:
          items:
            enum:
            - PUBLIC
            - INTERNAL
            - FEATURE_FLAG
            type: string
          type: array
          example:
          - PUBLIC
      required:
      - dataType
      - displayName
      - helpTxt
      - key
      - scope
      - tags
      type: object
    ConfigEntry_4:
      description: Configuration entry
      example:
        inherited: true
        value: value
        key: key
      properties:
        inherited:
          description: Is this configuration inherited?
          type: boolean
          example: true
        key:
          description: Configuration key
          type: string
          example: example-key
        value:
          description: Configuration value
          type: string
          example: example-value
      type: object
    YBPSuccess_4:
      example:
        success: true
        message: message
      properties:
        message:
          description: API response message.
          readOnly: true
          type: string
          example: Example message
        success:
          description: API operation status. A value of true indicates the operation was successful.
          readOnly: true
          type: boolean
          example: true
      type: object
    RuntimeConfigData_4:
      description: Runtime configuration data
      example:
        scopedConfigList:
        - configEntries:
          - inherited: true
            value: value
            key: key
          - inherited: true
            value: value
            key: key
          mutableScope: true
          type: GLOBAL
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - configEntries:
          - inherited: true
            value: value
            key: key
          - inherited: true
            value: value
            key: key
          mutableScope: true
          type: GLOBAL
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        scopedConfigList:
          description: List of scoped configurations
          items:
            $ref: '#/components/schemas/ScopedConfig_4'
          type: array
          example:
          - configEntries:
            - inherited: true
              value: value
              key: key
            - inherited: true
              value: value
              key: key
            mutableScope: true
            type: GLOBAL
            uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      type: object
  securitySchemes:
    apiKeyAuth:
      description: API token passed as header
      in: header
      name: X-AUTH-YW-API-TOKEN
      type: apiKey
externalDocs:
  description: About YugabyteDB Anywhere
  url: https://docs.yugabyte.com/latest/yugabyte-platform/
x-refined-from:
- openapi_2.yaml
- platform.swagger.json
- yugabytedb-anywhere-v1-full.yaml
- yugabytedb-anywhere-v1-releases-maintenance.yaml