YugabyteDB

YugabyteDB Table management API

The Table management API from YugabyteDB — 8 operation(s) for table management.

Documentation GitHub OpenAPI

Operations 12

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/namespaces Get a list of all namespaces in the specified universe. #

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/tables Get a list of all tables in the specified universe #

POST /api/v1/customers/{cUUID}/universes/{uniUUID}/tables Create a YugabyteDB table #

DELETE /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID} Drop a YugabyteDB table #

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID} Describe a table #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID} Alter a YugabyteDB table #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/bulk_import Bulk import data #

GET /api/v1/customers/{cUUID}/universes/{uniUUID}/tablespaces Get a list of all tablespaces of a given universe. #

POST /api/v1/customers/{cUUID}/universes/{uniUUID}/tablespaces Create tableSpaces #

GET /api/v1/metadata/yql_data_types List column types #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backup Create a multi-table backup #

PUT /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup Create a single-table backup #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yugabytedb-table-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yugabytedb Table management 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 Table management across 4 of this provider''s published API definitions: openapi_2.yaml, platform.swagger.json, yugabytedb-anywhere-v1-full.yaml, yugabytedb-anywhere-v1-universes.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
tags:
- name: Table management
paths:
  /api/v1/customers/{cUUID}/universes/{uniUUID}/namespaces:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAllNamespaces
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: includeSystemNamespaces
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NamespaceInfoResp'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get a list of all namespaces in the specified universe.
      tags:
      - Table management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/tables:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAllTables
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: includeParentTableInfo
        schema:
          default: false
          type: boolean
      - in: query
        name: excludeColocatedTables
        schema:
          default: false
          type: boolean
      - in: query
        name: includeColocatedParentTables
        schema:
          default: true
          type: boolean
      - in: query
        name: xClusterSupportedOnly
        schema:
          default: false
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/TableInfoResp'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get a list of all tables in the specified universe
      tags:
      - Table management
    post:
      description: YbaApi Internal.
      operationId: createTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableDefinitionTaskParams'
        description: Table definition to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create a YugabyteDB table
      tags:
      - Table management
      x-codegen-request-body-name: Table
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}:
    delete:
      description: YbaApi Internal.
      operationId: dropTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Drop a YugabyteDB table
      tags:
      - Table management
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: describeTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tableUUID
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableDefinitionTaskParams'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Describe a table
      tags:
      - Table management
    put:
      description: YbaApi Internal.
      operationId: alterTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Alter a YugabyteDB table
      tags:
      - Table management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/bulk_import:
    put:
      description: YbaApi Internal. Bulk import data into the specified table. This is currently AWS-only.
      operationId: bulkImportData
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImportParams'
        description: Bulk data to be imported
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Bulk import data
      tags:
      - Table management
      x-codegen-request-body-name: Bulk import
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/tablespaces:
    get:
      description: 'WARNING: This is a preview API that could change.'
      operationId: getAllTableSpaces
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/TableSpaceInfo'
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Get a list of all tablespaces of a given universe.
      tags:
      - Table management
    post:
      description: YbaApi Internal.
      operationId: createTableSpaces
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
      - in: query
        name: request
        schema: {}
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTablespaceParams'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: Create tableSpaces
      tags:
      - Table management
      x-codegen-request-body-name: CreateTableSpacesRequest
    servers:
    - url: /
  /api/v1/metadata/yql_data_types:
    get:
      description: YbaApi Internal. Get a list of all defined column types.
      operationId: getYQLDataTypes
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  enum:
                  - TINYINT
                  - SMALLINT
                  - INT
                  - BIGINT
                  - VARCHAR
                  - BOOLEAN
                  - FLOAT
                  - DOUBLE_PRECISION
                  - BLOB
                  - TIMESTAMP
                  - DECIMAL
                  - VARINT
                  - INET
                  - LIST
                  - MAP
                  - SET
                  - UUID
                  - TIMEUUID
                  - FROZEN
                  - DATE
                  - TIME
                  - JSONB
                  - USER_DEFINED_TYPE
                  type: string
                type: array
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: List column types
      tags:
      - Table management
    servers:
    - url: /
  /api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backup:
    put:
      description: ''
      operationId: createMultiTableBackup
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: uniUUID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: 'If requested schedule backup. Changes from upstream: This API call actually returns a task, not a Schedule'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask_2'
        '400':
          description: 'When request fails validations. Changes from upstream: Return code 400 is not in swagger spec'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPError'
      security:
      - apiKeyAuth: []
      summary: Create a multi-table backup
      tags:
      - Table management
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiTableBackupRequestParams'
        description: Table backup data to be created
        required: true
  /api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup:
    put:
      description: ''
      operationId: createSingleTableBackup
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: uniUUID
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: tableUUID
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask_2'
      security:
      - apiKeyAuth: []
      summary: Create a single-table backup
      tags:
      - Table management
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupTableParams'
        description: Backup data to be created
        required: true
components:
  schemas:
    BulkImportParams:
      description: Bulk import parameters
      example:
        expectedUniverseVersion: 0
        sourceXClusterConfigs:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        sse: true
        nodeExporterUser: nodeExporterUser
        encryptionAtRestConfig:
          encryptionAtRestEnabled: true
          opType: ENABLE
          kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          type: CMK
        tableName: tableName
        ybcSoftwareVersion: ybcSoftwareVersion
        creatingUser:
          ldapSpecifiedRole: true
          customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          role: Admin
          authTokenIssueDate: 2021-06-17 15:00:05+00:00
          timezone: timezone
          oidcJwtAuthToken: oidcJwtAuthToken
          groupMemberships:
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          userType: local
          creationDate: 2022-12-12 13:07:18+00:00
          uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          email: username1@example.com
          primary: true
        extraDependencies:
          installNodeExporter: true
        platformVersion: platformVersion
        sleepAfterTServerRestartMillis: 5
        runOnlyPrechecks: true
        platformUrl: platformUrl
        targetXClusterConfigs:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        ybPrevSoftwareVersion: ybPrevSoftwareVersion
        deviceInfo:
          cloudVolumeEncryption:
            enableVolumeEncryption: true
            kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          diskIops: 6
          storageClass: storageClass
          numVolumes: 7
          mountPoints: mountPoints
          storageType: IO1
          throughput: 1
          volumeSize: 4
        enableYbc: true
        s3Bucket: s3Bucket
        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        keyspace: keyspace
        universeUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        errorString: errorString
        installYbc: true
        nodeDetailsSet:
        - nodeName: nodeName
          nodeExporterPort: 3
          placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ybControllerHttpPort: 3
          dedicatedTo: MASTER
          machineImage: machineImage
          redisServerHttpPort: 2
          masterState: ToStart
          tserverRpcPort: 6
          ysqlServerHttpPort: 7
          yqlServerRpcPort: 0
          otelCollectorMetricsPort: 1
          isMaster: true
          sshUserOverride: sshUserOverride
          cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          sshPortOverride: 6
          cronsActive: true
          state: Provisioned
          nodeIdx: 6
          masterRpcPort: 6
          redisServerRpcPort: 6
          lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
          tserverHttpPort: 5
          disksAreMountedByUUID: true
          isRedisServer: true
          ybPrebuiltAmi: true
          internalYsqlServerRpcPort: 8
          isTserver: true
          nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          isYsqlServer: true
          ybControllerRpcPort: 3
          isYqlServer: true
          azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          masterHttpPort: 9
          ysqlServerRpcPort: 6
          autoSyncMasterAddrs: true
          yqlServerHttpPort: 7
        - nodeName: nodeName
          nodeExporterPort: 3
          placementUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          ybControllerHttpPort: 3
          dedicatedTo: MASTER
          machineImage: machineImage
          redisServerHttpPort: 2
          masterState: ToStart
          tserverRpcPort: 6
          ysqlServerHttpPort: 7
          yqlServerRpcPort: 0
          otelCollectorMetricsPort: 1
          isMaster: true
          sshUserOverride: sshUserOverride
          cloudInfo:
            mount_roots: mount_roots
            kubernetesNamespace: kubernetesNamespace
            public_ip: public_ip
            secondary_subnet_id: secondary_subnet_id
            private_dns: private_dns
            useTimeSync: true
            kubernetesPodName: kubernetesPodName
            root_volume: root_volume
            secondary_private_ip: secondary_private_ip
            private_ip: private_ip
            cloud: cloud
            lun_indexes:
            - 6
            - 6
            assignPublicIP: true
            az: az
            subnet_id: subnet_id
            public_dns: public_dns
            region: region
            instance_type: instance_type
          sshPortOverride: 6
          cronsActive: true
          state: Provisioned
          nodeIdx: 6
          masterRpcPort: 6
          redisServerRpcPort: 6
          lastVolumeUpdateTime: 2022-12-12 13:07:18+00:00
          tserverHttpPort: 5
          disksAreMountedByUUID: true
          isRedisServer: true
          ybPrebuiltAmi: true
          internalYsqlServerRpcPort: 8
          isTserver: true
          nodeUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          isYsqlServer: true
          ybControllerRpcPort: 3
          isYqlServer: true
          azUuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          masterHttpPort: 9
          ysqlServerRpcPort: 6
          autoSyncMasterAddrs: true
          yqlServerHttpPort: 7
        instanceCount: 6
        ybcInstalled: true
        communicationPorts:
          nodeExporterPort: 5
          tserverHttpPort: 9
          internalYsqlServerRpcPort: 0
          ybControllerHttpPort: 2
          redisServerHttpPort: 2
          ybControllerrRpcPort: 4
          tserverRpcPort: 3
          ysqlServerHttpPort: 1
          yqlServerRpcPort: 1
          masterHttpPort: 6
          otelCollectorMetricsPort: 5
          ysqlServerRpcPort: 1
          yqlServerHttpPort: 7
          masterRpcPort: 1
          redisServerRpcPort: 7
        cmkArn: cmkArn
        sleepAfterMasterRestartMillis: 1
        previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        cmkArn:
          description: Amazon Resource Name (ARN) of the CMK
          type: string
        communicationPorts:
          $ref: '#/components/schemas/CommunicationPorts'
        creatingUser:
          $ref: '#/components/schemas/Users'
        deviceInfo:
          $ref: '#/components/schemas/DeviceInfo'
        enableYbc:
          type: boolean
        encryptionAtRestConfig:
          $ref: '#/components/schemas/EncryptionAtRestConfig'
        errorString:
          description: Error message
          type: string
        expectedUniverseVersion:
          description: Expected universe version
          format: int32
          type: integer
        extraDependencies:
          $ref: '#/components/schemas/ExtraDependencies'
        installYbc:
          type: boolean
        instanceCount:
          description: Instance count
          format: int32
          type: integer
        keyspace:
          description: Key space
          type: string
        nodeDetailsSet:
          description: Node details
          items:
            $ref: '#/components/schemas/NodeDetails'
          type: array
          uniqueItems: true
        nodeExporterUser:
          description: Node exporter user
          type: string
        platformUrl:
          type: string
        platformVersion:
          readOnly: true
          type: string
        previousTaskUUID:
          description: Previous task UUID of a retry
          format: uuid
          type: string
        runOnlyPrechecks:
          description: YbaApi Internal. Run only prechecks during task run
          type: boolean
        s3Bucket:
          description: S3 bucket URL
          type: string
        sleepAfterMasterRestartMillis:
          format: int32
          type: integer
        sleepAfterTServerRestartMillis:
          format: int32
          type: integer
        sourceXClusterConfigs:
          description: The source universe's xcluster replication relationships
          items:
            format: uuid
            type: string
          readOnly: true
          type: array
        sse:
          description: Is SSE
          type: boolean
        tableName:
          description: Table name
          type: string
        tableUUID:
          description: Table UUID
          format: uuid
          type: string
        targetXClusterConfigs:
          description: The target universe's xcluster replication relationships
          items:
            format: uuid
            type: string
          readOnly: true
          type: array
        universeUUID:
          description: Associated universe UUID
          format: uuid
          type: string
        ybPrevSoftwareVersion:
          description: Previous software version
          type: string
        ybcInstalled:
          type: boolean
        ybcSoftwareVersion:
          type: string
      required:
      - creatingUser
      - platformUrl
      - s3Bucket
      - sleepAfterMasterRestartMillis
      - sleepAfterTServerRestartMillis
      type: object
    TableInfoResp:
      description: Table information response
      example:
        relationType: SYSTEM_TABLE_RELATION
        colocated: true
        walSizeBytes: 3.616076749251911
        indexTableIDs:
        - indexTableIDs
        - indexTableIDs
        pgSchemaName: public
        sizeBytes: 9.301444243932576
        tableName: tableName
        tableSpace: tableSpace
        tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        mainTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        parentTableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        tableType: YQL_TABLE_TYPE
        keySpace: keySpace
        tableID: tableID
        nameSpace: nameSpace
        colocationParentId: colocationParentId
      properties:
        colocated:
          description: Flag, indicating colocated table
          type: boolean
        colocationParentId:
          description: Colocation parent id
          type: string
        indexTableIDs:
          description: Index Table IDs of main table
          items:
            type: string
          type: array
        keySpace:
          description: Keyspace
          type: string
        mainTableUUID:
          description: Main Table UUID of index tables
          format: uuid
          type: string
        nameSpace:
          description: Namespace or Schema
          type: string
        parentTableUUID:
          description: Parent Table UUID
          format: uuid
          type: string
        pgSchemaName:
          description: Postgres schema name of the table
          example: public
          type: string
        relationType:
          description: Relation type
          enum:
          - SYSTEM_TABLE_RELATION
          - USER_TABLE_RELATION
          - INDEX_TABLE_RELATION
          - MATVIEW_TABLE_RELATION
          - COLOCATED_PARENT_TABLE_RELATION
          type: string
        sizeBytes:
          description: SST size in bytes
          format: double
          readOnly: true
          type: number
        tableID:
          description: Table ID
          readOnly: true
          type: string
        tableName:
          description: Table name
          type: string
        tableSpace:
          description: Table space
          type: string
        tableType:
          description: Table type
          enum:
          - YQL_TABLE_TYPE
          - REDIS_TABLE_TYPE
          - PGSQL_TABLE_TYPE
          - TRANSACTION_STATUS_TABLE_TYPE
          type: string
        tableUUID:
          description: Table UUID
          format: uuid
          readOnly: true
          type: string
        walSizeBytes:
          description: WAL size in bytes
          format: double
          readOnly: true
          type: number
      type: object
    CloudVolumeEncryption:
      description: Volume encryption settings for AWS EBS volumes
      example:
        enableVolumeEncryption: true
        kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      properties:
        enableVolumeEncryption:
          description: To enable volume encryption or not
          type: boolean
        kmsConfigUUID:
          description: KMS config UUID to be used for volume encryption
          format: uuid
          type: string
      type: object
    PlacementBlock:
      example:
        cloud: cloud
        leader_preference: 1
        zone: zone
        min_num_replicas: 1
        region: region
      properties:
        cloud:
          description: Cloud
          maxLength: 2147483647
          minLength: 1
          type: string
        leader_preference:
          description: Leader preference
          format: int32
          minimum: 1
          type: integer
        min_num_replicas:
          description: Minimum replicas
          format: int32
          minimum: 1
          type: integer
        region:
          description: Region
          maxLength: 2147483647
          minLength: 1
          type: string
        zone:
          description: Zone
          maxLength: 2147483647
          minLength: 1
          type: string
      required:
      - cloud
      - region
      - zone
      type: object
    Users:
      description: A user associated with a customer
      example:
        ldapSpecifiedRole: true
        customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        role: Admin
        authTokenIssueDate: 2021-06-17 15:00:05+00:00
        timezone: timezone
        oidcJwtAuthToken: oidcJwtAuthToken
        groupMemberships:
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        userType: local
        creationDate: 2022-12-12 13:07:18+00:00
        uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        email: username1@example.com
        primary: true
      properties:
        authTokenIssueDate:
          description: UI session token creation date
          example: 2021-06-17 15:00:05+00:00
          format: date-time
          readOnly: true
          type: string
        creationDate:
          description: User creation date
          example: 2022-12-12 13:07:18+00:00
          format: date-time
          readOnly: true
          type: string
        customerUUID:
          description: Customer UUID
          format: uuid
          readOnly: true
          type: string
        email:
          description: User email address
          example: username1@example.com
          type: string
        groupMemberships:
          items:
            format: uuid
            type: string
          type: array
          uniqueItems: true
        ldapSpecifiedRole:
          description: LDAP Specified Role
          type: boolean
        oidcJwtAuthToken:
          readOnly: true
          type: string
        primary:
          type: boolean
        role:
          description: <b style="color:#ff0000">Deprecated since YBA version 2.19.3.0.</b> Use  getRoleBindings instead.
          enum:
          - ConnectOnly
          - ReadOnly
          - BackupAdmin
          - Admin
          - SuperAdmin
          example: Admin
          type: string
        timezone:
          description: User timezone
          type: string
        userType:
          description: User Type
          enum:
          - local
          - ldap
          - oidc
          type: string
        uuid:
          description: User UUID
          format: uuid
          readOnly: true
          type: string
      required:
      - email
      - groupMemberships
      - primary
      type: object
    ColumnDetails:
      description: Details of a CQL database column
      example:
        columnOrder: 5
        isClusteringKey: true
        sortOrder: NONE
        valueType: TINYINT
        name: name
        keyType: TINYINT
        type: TINYINT
        isPartitionKey: true
      properties:
        columnOrder:
          description: Relative position (column order) for this column, in the table and in CQL commands
          format: int32
          type: integer
        isClusteringKey:
          description: True if this column is a clustering key
          type: boolean
        isPartitionKey:
          description: True if this column is a partition key
          type: boolean
        keyType:
          description: Column key type
          enum:
          - TINYINT
          - SMALLINT
          - INT
          - BIGINT
          - VARCHAR
          - BOOLEAN
          - FLOAT
          - DOUBLE_PRECISION
          - BLOB
          - TIMESTAMP
          - DECIMAL
          - VARINT
          - INET
          - LIST
          - MAP
          - SET
          - UUID
          - TIMEUUID
          - FROZEN
          - DATE
          - TIME
          - JSONB
          - USER_DEFINED_TYPE
          type: string
        name:
          description: Column name
          type: string
        sortOrder:
          description: Sort order for this column. Valid only for clustering columns.
          enum:
          - NONE
          - ASC
          - DESC
          type: string
        type:
          description: The column's data type
          enum:
          - TINYINT
          - SMALLINT
          - INT
          - BIGINT
          - VARCHAR
          - BOOLEAN
          - FLOAT
          - DOUBLE_PRECISION
          - BLOB
          - TIMESTAMP
          - DECIMAL
          - VARINT
          - INET
          - LIST
          - MAP
          - SET
          - UUID
          - TIMEUUID
          - FROZEN
          - DATE
          - TIME
          - JSONB
          - USER_DEFINED_TYPE
          type: string
        valueType:
          description: Column value name
          enum:
          - TINYINT
          - SMALLINT
          - INT
          - BIGINT
          - VARCHAR
          - BOOLEAN
          - FLOAT
          - DOUBLE_PRECISION
          - BLOB
          - TIMESTAMP
          - DECIMAL
          - VARINT
          - INET
          - LIST
          - MAP
          - SET
          - UUID
          - TIMEUUID
          - FROZEN
          - DATE
          - TIME
          - JSONB
          - USER_DEFINED_TYPE
          type: string
      type: object
    CreateTablespaceParams:
      example:
        tablespaceInfos:
        - numReplicas: 1
          name: name
          placementBlocks:
          - cloud: cloud
            leader_preference: 1
            zone: zone
            min_num_replicas: 1
            region: region
          - cloud: cloud
            leader_preference: 1
            zone: zone
    

# --- truncated at 32 KB (222 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/openapi/yugabytedb-table-management-api-openapi.yml