YugabyteDB Table management API

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

Documentation

Specifications

Other Resources

🔗
CLI
https://github.com/yugabyte/ybm-cli
🔗
Integrations
https://github.com/yugabyte/terraform-provider-ybm
🔗
TermsOfService
https://www.yugabyte.com/yugabytedb-managed-service-terms/
🔗
SDKs
https://github.com/yugabyte/platform-go-client
🔗
Integrations
https://github.com/yugabyte/terraform-provider-yba
🔗
Integrations
https://github.com/yugabyte/yugabyte-k8s-operator
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybuniverse.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-backup-schedule.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-restore-job.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-storage-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-dr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-pitr-config.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-release.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-support-bundle.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybcertificate.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybprovider.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/yugabytedb/refs/heads/main/crd/yugabytedb-ybplatform.yaml

OpenAPI Specification

yugabytedb-table-management-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: YugabyteDB Aeon REST Access Keys Table management API
  description: The YugabyteDB Aeon REST API provides programmatic access to YugabyteDB's fully managed cloud database service. Developers and operators can use it to deploy and manage database clusters, configure read replicas, schedule and execute on-demand backups and restores, manage IP allow lists, and set up monitoring and alerts. Authentication is performed using API keys passed as bearer tokens in the Authorization header. All paths are scoped to an account and project, which can be obtained from the YugabyteDB Aeon UI profile page.
  version: v1
  contact:
    name: Yugabyte Support
    url: https://support.yugabyte.com
  termsOfService: https://www.yugabyte.com/yugabytedb-managed-service-terms/
  x-generated-from: documentation
  x-source-url: https://api-docs.yugabyte.com/docs/managed-apis/
  x-last-validated: '2026-05-03'
servers:
- url: https://cloud.yugabyte.com/api/public/v1
  description: YugabyteDB Aeon Production Server
security:
- bearerAuth: []
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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: includeSystemNamespaces
        schema:
          default: false
          type: boolean
        example: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/NamespaceInfoResp'
                type: array
              examples:
                GetAllNamespaces200Example:
                  summary: Default getAllNamespaces 200 response
                  x-microcks-default: true
                  value:
                  - tableType: YQL_TABLE_TYPE
                    name: name
                    namespaceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get a List of All Namespaces in the Specified Universe.
      tags:
      - Table management
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: includeParentTableInfo
        schema:
          default: false
          type: boolean
        example: false
      - in: query
        name: excludeColocatedTables
        schema:
          default: false
          type: boolean
        example: false
      - in: query
        name: includeColocatedParentTables
        schema:
          default: true
          type: boolean
        example: true
      - in: query
        name: xClusterSupportedOnly
        schema:
          default: false
          type: boolean
        example: false
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/TableInfoResp'
                type: array
              examples:
                GetAllTables200Example:
                  summary: Default getAllTables 200 response
                  x-microcks-default: true
                  value:
                  - 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
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Get a List of All Tables in the Specified Universe
      tags:
      - Table management
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      description: YbaApi Internal.
      operationId: createTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TableDefinitionTaskParams'
            examples:
              CreateTableRequestExample:
                summary: Default createTable request
                x-microcks-default: true
                value:
                  expectedUniverseVersion: 0
                  sourceXClusterConfigs:
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  nodeExporterUser: nodeExporterUser
                  encryptionAtRestConfig:
                    encryptionAtRestEnabled: true
                    opType: ENABLE
                    kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    type: CMK
                  tableType: YQL_TABLE_TYPE
                  ybcSoftwareVersion: ybcSoftwareVersion
                  creatingUser:
                    ldapSpecifiedRole: true
                    customerUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    role: Admin
                    authTokenIssueDate: '2021-06-17T15:00:05+00:00'
                    timezone: timezone
                    oidcJwtAuthToken: oidcJwtAuthToken
                    groupMemberships:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    userType: local
                    creationDate: '2022-12-12T13:07:18+00:00'
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    email: username1@example.com
                    primary: true
                  extraDependencies:
                    installNodeExporter: true
                  platformVersion: platformVersion
                  sleepAfterTServerRestartMillis: 1
                  tableDetails:
                    keyspace: keyspace
                    columns:
                    - columnOrder: 5
                      isClusteringKey: true
                      sortOrder: NONE
                      valueType: TINYINT
                      name: name
                      keyType: TINYINT
                      type: TINYINT
                      isPartitionKey: true
                    - columnOrder: 5
                      isClusteringKey: true
                      sortOrder: NONE
                      valueType: TINYINT
                      name: name
                      keyType: TINYINT
                      type: TINYINT
                      isPartitionKey: true
                    ttlInSeconds: 5
                    splitValues:
                    - splitValues
                    - splitValues
                    tableName: tableName
                  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
                  tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                  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-12T13: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-12T13: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
                  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: 6
                  previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
        description: Table definition to be created
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                CreateTable200Example:
                  summary: Default createTable 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Create a YugabyteDB Table
      tags:
      - Table management
      x-codegen-request-body-name: Table
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YBPTask'
              examples:
                DropTable200Example:
                  summary: Default dropTable 200 response
                  x-microcks-default: true
                  value:
                    taskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    resourceUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Drop a YugabyteDB Table
      tags:
      - Table management
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tableUUID
        required: true
        schema:
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TableDefinitionTaskParams'
              examples:
                DescribeTable200Example:
                  summary: Default describeTable 200 response
                  x-microcks-default: true
                  value:
                    expectedUniverseVersion: 0
                    sourceXClusterConfigs:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    nodeExporterUser: nodeExporterUser
                    encryptionAtRestConfig:
                      encryptionAtRestEnabled: true
                      opType: ENABLE
                      kmsConfigUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                      type: CMK
                    tableType: YQL_TABLE_TYPE
                    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: 1
                    tableDetails:
                      keyspace: keyspace
                      columns:
                      - columnOrder: 5
                        isClusteringKey: true
                        sortOrder: NONE
                        valueType: TINYINT
                        name: name
                        keyType: TINYINT
                        type: TINYINT
                        isPartitionKey: true
                      - columnOrder: 5
                        isClusteringKey: true
                        sortOrder: NONE
                        valueType: TINYINT
                        name: name
                        keyType: TINYINT
                        type: TINYINT
                        isPartitionKey: true
                      ttlInSeconds: 5
                      splitValues:
                      - splitValues
                      - splitValues
                      tableName: tableName
                    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
                    tableUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    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
                    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: 6
                    previousTaskUUID: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Describe a Table
      tags:
      - Table management
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    put:
      description: YbaApi Internal.
      operationId: alterTable
      parameters:
      - in: path
        name: cUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties:
                  properties: {}
                  type: object
                type: object
              examples:
                AlterTable200Example:
                  summary: Default alterTable 200 response
                  x-microcks-default: true
                  value: {}
          description: successful operation
      security:
      - apiKeyAuth: []
      summary: YugabyteDB Anywhere Alter a YugabyteDB Table
      tags:
      - Table management
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /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
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: uniUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: path
        name: tableUUID
        required: true
        schema:
          format: uuid
          type: string
        example: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
      - in: query
        name: request
        schema: {}
        example: example-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkImportParams'
            examples:
              BulkImportDataRequestExample:
                summary: Default bulkImportData request
                x-microcks-default: true
                value:
                  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-17T15:00:05+00:00'
                    timezone: timezone
                    oidcJwtAuthToken: oidcJwtAuthToken
                    groupMemberships:
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    - 046b6c7f-0b8a-43b9-b35d-6489e6daee91
                    userType: local
                    creationDate: '2022-12-12T13:07:18+00:00'
                    uuid: 046b6c7f-0b8a-43b9-b35d-6489e6daee91
         

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