Get Table

Get Table

POST /api/v1/dl/get_table

Returns details for a single Tableflow table, looked up by UUID or by name.

Request

Field	Type	Required	Description
virtual_cluster_id	string	Yes	The ID of the Tableflow virtual cluster.
table_uuid	string	Optional*	The UUID of the table to retrieve.
table_name	string	Optional*	The name of the table to retrieve.

Exactly one of table_uuid or table_name must be specified. Providing both or neither will return an error.

CURL Example (by UUID)

curl [https://api.warpstream.com/api/v1/dl/get_table](https://api.warpstream.com/api/v1/dl/get_table) \
  -H 'warpstream-api-key: XXXXXXXXXX' \
  -H 'Content-Type: application/json' \
  -d '{
    "virtual_cluster_id": "vci_XXXXXXXX_XXXX_XXXX_XXXX_XXXXXXXXXXXX", 
    "table_uuid": "550e8400-e29b-41d4-a716-446655440000"
  }'

Response

{
  "table": {
    "table_name": "my_cluster.my_topic.a1b2c3d4",
    "table_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "source_stream_name": "my_topic",
    "source_cluster_name": "my_cluster",
    "stats_estimated_byte_count": 1048576,
    "stats_estimated_row_count": 10000,
    "created_at_unix_nanos": 1700000000000000000
  }
}

Field	Type	Description
table.table_name	string	The full name of the table.
table.table_uuid	string	The unique identifier of the table.
table.source_stream_name	string	The source Kafka topic name.
table.source_cluster_name	string	The name of the source cluster.
table.stats_estimated_byte_count	integer	Estimated total size of the table in bytes.
table.stats_estimated_row_count	integer	Estimated total number of rows in the table.
table.created_at_unix_nanos	integer	Table creation timestamp in nanoseconds since Unix epoch.