How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

YugabyteDB Table management API

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

This API exposes 12 operations across 8 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /.

12 operations 8 paths 37 schemas 1 DELETE5 GET2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://cloud.yugabyte.com/api/public/v1
Authentication
API Key
Contact
https://docs.yugabyte.com
Terms of Service
Resource Areas
1

Authentication & Security 1

YugabyteDB Table management API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-AUTH-YW-API-TOKEN (apiKeyAuth).

  • apiKeyAuth — API token passed as header

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 5 GET, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Table Management 12
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/namespaces
Get a list of all namespaces in the specified universe
getAllNamespaces 3 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables
Get a list of all tables in the specified universe
getAllTables 6 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables
Create a YugabyteDB table
createTable 3 params body → 200
DELETE
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}
Drop a YugabyteDB table
dropTable 4 params → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}
Describe a table
describeTable 3 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}
Alter a YugabyteDB table
alterTable 4 params → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/bulk_import
Bulk import data
bulkImportData 4 params body → 200
GET
/api/v1/customers/{cUUID}/universes/{uniUUID}/tablespaces
Get a list of all tablespaces of a given universe
getAllTableSpaces 2 params → 200
POST
/api/v1/customers/{cUUID}/universes/{uniUUID}/tablespaces
Create tableSpaces
createTableSpaces 3 params body → 200
GET
/api/v1/metadata/yql_data_types
List column types
getYQLDataTypes → 200
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/multi_table_backup
Create a multi-table backup
createMultiTableBackup 2 params body → 200400
PUT
/api/v1/customers/{cUUID}/universes/{uniUUID}/tables/{tableUUID}/create_backup
Create a single-table backup
createSingleTableBackup 3 params body → 200

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are BackupTableParams (49 properties), MultiTableBackupRequestParams (49 properties), NodeDetails (37 properties), BulkImportParams (30 properties). Each schema is shown below with its type and property counts.

TableInfoResp
object
Table information response
16 properties
NamespaceInfoResp
object
Namespace information response
3 properties
CommunicationPorts
object
Communication ports
15 properties
TableDetails
object
Table details
5 properties
BulkImportParams
object
Bulk import parameters
30 properties 5 required
YBPTask
object
2 properties
NodeDetails
object
Details of a cloud node
37 properties
ColumnDetails
object
Details of a CQL database column
8 properties
DeviceInfo
object
Device information
8 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
TableDefinitionTaskParams
object
27 properties 7 required
TableSpaceInfo
object
Tablespace information
3 properties 2 required
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
PlacementBlock
object
5 properties 3 required
Users
object
A user associated with a customer
12 properties 3 required
CreateTablespaceParams
object
1 property 1 required
ExtraDependencies
object
Extra dependencies
1 property
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
TableDetails_2
object
Table details
5 properties
CloudSpecificInfo_2
object
Node information reported by the cloud provider
14 properties
TableSpaceInfo_2
object
Tablespace information
3 properties 2 required
TableDefinitionTaskParams_2
object
18 properties 3 required
ExtraDependencies_2
object
Extra dependencies
1 property
CommunicationPorts_2
object
Communication ports
11 properties
YBPTask_2
object
2 properties
BackupTableParams
object
Backup table parameters
49 properties 1 required
YBPError
object
Generic error response from the YugabyteDB Anywhere API
3 properties
PlacementBlock_2
object
5 properties 3 required
BulkImportParams_2
object
Bulk import parameters
21 properties 1 required
ColumnDetails_2
object
Details of a CQL database column
8 properties
DeviceInfo_2
object
Device information
7 properties
RegionLocations
object
2 properties 2 required
MultiTableBackupRequestParams
object
Multi-table backup parameters
49 properties 1 required
NodeDetails_2
object
Details of a cloud node
28 properties
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
CreateTablespaceParams_2
object
1 property 1 required
TableInfoResp_2
object
Table information response
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yugabytedb-table-management-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of YugabyteDB Table management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.