YugabyteDB Table management API is one of 73 APIs that YugabyteDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Table management. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes
12 operations
across 8 paths,
and defines 36 schemas.
It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://cloud.yugabyte.com/api/public/v1.
12 operations8 paths36 schemas1 DELETE5 GET2 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
YugabyteDB Table management API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated.
bearerAuth — API key obtained from the YugabyteDB Aeon UI under User Profile API Keys. Pass the key as a Bearer token in the Authorization 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.
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are NodeDetails_2 (37 properties), NodeDetails (37 properties), BulkImportParams (30 properties), BulkImportParams_2 (30 properties). Each schema is shown below with its type and property counts.
EncryptionAtRestConfig
object
Encryption at rest configuration
4 properties
DeviceInfo
object
Device information
8 properties
NamespaceInfoResp
object
Namespace information response
3 properties
TableSpaceInfo
object
Tablespace information
3 properties2 required
NodeDetails
object
Details of a cloud node
37 properties
CloudVolumeEncryption
object
Volume encryption settings for AWS EBS volumes
2 properties
ExtraDependencies
object
Extra dependencies
1 property
PlacementBlock
object
5 properties3 required
TableDefinitionTaskParams
object
27 properties7 required
TableDetails
object
Table details
5 properties
CreateTablespaceParams
object
1 property1 required
BulkImportParams
object
Bulk import parameters
30 properties5 required
CommunicationPorts
object
Communication ports
15 properties
CloudSpecificInfo
object
Node information reported by the cloud provider
18 properties
ColumnDetails
object
Details of a CQL database column
8 properties
TableInfoResp
object
Table information response
16 properties
YBPTask
object
2 properties
Users
object
A user associated with a customer
12 properties3 required
EncryptionAtRestConfig_2
object
Encryption at rest configuration
4 properties
DeviceInfo_2
object
Device information
8 properties
NamespaceInfoResp_2
object
Namespace information response
3 properties
TableSpaceInfo_2
object
Tablespace information
3 properties2 required
NodeDetails_2
object
Details of a cloud node
37 properties
CloudVolumeEncryption_2
object
Volume encryption settings for AWS EBS volumes
2 properties
ExtraDependencies_2
object
Extra dependencies
1 property
PlacementBlock_2
object
5 properties3 required
TableDefinitionTaskParams_2
object
27 properties7 required
TableDetails_2
object
Table details
5 properties
CreateTablespaceParams_2
object
1 property1 required
BulkImportParams_2
object
Bulk import parameters
30 properties5 required
CommunicationPorts_2
object
Communication ports
15 properties
CloudSpecificInfo_2
object
Node information reported by the cloud provider
18 properties
ColumnDetails_2
object
Details of a CQL database column
8 properties
TableInfoResp_2
object
Table information response
16 properties
YBPTask_2
object
2 properties
Users_2
object
A user associated with a customer
12 properties3 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
