--- title: Tables description: Manage tables in an InfluxDB 3 Cloud Dedicated database, including creating tables with custom column schemas. url: https://docs.influxdata.com/influxdb3/cloud-dedicated/api/management-api/tables/ estimated_tokens: 3306 product: InfluxDB 3 Cloud version: cloud publisher: InfluxData canonical: https://docs.influxdata.com/influxdb3/cloud-dedicated/api/management-api/tables/ --- [Download Cloud Dedicated Management API Spec](/openapi/influxdb-cloud-dedicated-management-api.yml) Manage tables in an InfluxDB 3 Cloud Dedicated database, including creating tables with custom column schemas. POST`/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables` ### Create a database table Create a table. The database must already exist. With InfluxDB Cloud Dedicated, tables and measurements are synonymous. Typically, tables are created automatically on write using the measurement name specified in line protocol written to InfluxDB. However, to apply a custom partition template to a table, you must manually create the table with custom partitioning before you write any data to it. Partitioning defaults to `%Y-%m-%d` (daily). When a partition template is applied to a database, it becomes the default template for all tables in that database, but can be overridden when creating a table. #### Parameters ##### Path parameters `accountId`requiredstring The ID of the account to create the database table for `clusterId`requiredstring The ID of the cluster to create the database table for `databaseName`requiredstring The name of the database to create the database table for #### Request bodyrequired Content-Type:`application/json` `name`requiredstring The name of the cluster database table `partitionTemplate`object[] A template for partitioning a cluster database. Each partition template part is evaluated in sequence. The outputs from each part are concatenated with the`|` delimiter to form the final partition key. For example, using the partition template below: ```json [ { "type": "time", "value": "%Y" }, { "type": "tag", "value": "bananas" }, { "type": "tag", "value": "plátanos" }, { "type": "bucket", "value": { "tagName": "c", "numberOfBuckets": 10 } } ] ``` The following partition keys are derived: * `time=2023-01-01, a=bananas, b=plátanos, c=ananas` -\> `2023|bananas|plátanos|5` * `time=2023-01-01, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01, another=cat, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01` -\> `2023|!|!|!` * `time=2023-01-01, a=cat|dog, b=!, c=!` -\> `2023|cat%7Cdog|%21|8` * `time=2023-01-01, a=%50, c=%50` -\> `2023|%2550|!|9` * `time=2023-01-01, a=, c=` -\> `2023|^|!|0` * `time=2023-01-01, a=` -\> `2023|#|!|!` * `time=2023-01-01, c=` -\> `2023|!|!|` When using the default partitioning template (YYYY-MM-DD) there is no encoding necessary, as the derived partition key contains a single part, and no reserved characters. [`TemplatePart::Bucket`] parts by definition will always be within the part length limit and contain no restricted characters so are also not percent-encoded and/or truncated. Example request[Ask AI about this](#) ```sh curl --request POST \ "https://console.influxdata.com/api/v0/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "name": "NAME", "partitionTemplate": [ "PARTITIONTEMPLATE" ] }' ``` #### Responses 200The cluster database table was successfully created `accountId`requiredstring \ `clusterId`requiredstring \ `databaseName`requiredstring The name of the cluster database `name`requiredstring The name of the cluster database table `partitionTemplate`object[] A template for partitioning a cluster database. Each partition template part is evaluated in sequence. The outputs from each part are concatenated with the`|` delimiter to form the final partition key. For example, using the partition template below: ```json [ { "type": "time", "value": "%Y" }, { "type": "tag", "value": "bananas" }, { "type": "tag", "value": "plátanos" }, { "type": "bucket", "value": { "tagName": "c", "numberOfBuckets": 10 } } ] ``` The following partition keys are derived: * `time=2023-01-01, a=bananas, b=plátanos, c=ananas` -\> `2023|bananas|plátanos|5` * `time=2023-01-01, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01, another=cat, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01` -\> `2023|!|!|!` * `time=2023-01-01, a=cat|dog, b=!, c=!` -\> `2023|cat%7Cdog|%21|8` * `time=2023-01-01, a=%50, c=%50` -\> `2023|%2550|!|9` * `time=2023-01-01, a=, c=` -\> `2023|^|!|0` * `time=2023-01-01, a=` -\> `2023|#|!|!` * `time=2023-01-01, c=` -\> `2023|!|!|` When using the default partitioning template (YYYY-MM-DD) there is no encoding necessary, as the derived partition key contains a single part, and no reserved characters. [`TemplatePart::Bucket`] parts by definition will always be within the part length limit and contain no restricted characters so are also not percent-encoded and/or truncated. 400Bad Request `code`requiredinteger `message`requiredstring 401Unauthorized `code`requiredinteger `message`requiredstring 403Forbidden `code`requiredinteger `message`requiredstring 404Not Found `code`requiredinteger `message`requiredstring 409Conflict `code`requiredinteger `message`requiredstring 500Internal Server Error `code`requiredinteger `message`requiredstring PUT`/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables/{tableId}/undelete` ### Undelete a database table Restores a previously deleted database table. This operation can only be performed on tables that have been soft-deleted and are still within the recovery window. #### Parameters ##### Path parameters `accountId`requiredstring The ID of the account that the database table belongs to `clusterId`requiredstring The ID of the cluster that the database table belongs to `databaseName`requiredstring The name of the database that the table belongs to `tableId`requiredinteger \ The ID of the table to undelete Example request[Ask AI about this](#) ```sh curl --request PUT \ "https://console.influxdata.com/api/v0/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables/{tableId}/undelete" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200The cluster database table was successfully undeleted `accountId`requiredstring \ `clusterId`requiredstring \ `databaseName`requiredstring The name of the cluster database `id`requiredinteger \ The ID of the table `name`requiredstring The name of the cluster database table `partitionTemplate`object[] A template for partitioning a cluster database. Each partition template part is evaluated in sequence. The outputs from each part are concatenated with the`|` delimiter to form the final partition key. For example, using the partition template below: ```json [ { "type": "time", "value": "%Y" }, { "type": "tag", "value": "bananas" }, { "type": "tag", "value": "plátanos" }, { "type": "bucket", "value": { "tagName": "c", "numberOfBuckets": 10 } } ] ``` The following partition keys are derived: * `time=2023-01-01, a=bananas, b=plátanos, c=ananas` -\> `2023|bananas|plátanos|5` * `time=2023-01-01, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01, another=cat, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01` -\> `2023|!|!|!` * `time=2023-01-01, a=cat|dog, b=!, c=!` -\> `2023|cat%7Cdog|%21|8` * `time=2023-01-01, a=%50, c=%50` -\> `2023|%2550|!|9` * `time=2023-01-01, a=, c=` -\> `2023|^|!|0` * `time=2023-01-01, a=` -\> `2023|#|!|!` * `time=2023-01-01, c=` -\> `2023|!|!|` When using the default partitioning template (YYYY-MM-DD) there is no encoding necessary, as the derived partition key contains a single part, and no reserved characters. [`TemplatePart::Bucket`] parts by definition will always be within the part length limit and contain no restricted characters so are also not percent-encoded and/or truncated. 400Bad Request `code`requiredinteger `message`requiredstring 401Unauthorized `code`requiredinteger `message`requiredstring 403Forbidden `code`requiredinteger `message`requiredstring 404Not Found `code`requiredinteger `message`requiredstring 500Internal Server Error `code`requiredinteger `message`requiredstring DELETE`/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables/{tableName}` ### Delete a database table #### Parameters ##### Path parameters `accountId`requiredstring The ID of the account that the database table belongs to `clusterId`requiredstring The ID of the cluster that the database table belongs to `databaseName`requiredstring The name of the database that the database table belongs to `tableName`requiredstring The name of the database table to delete Example request[Ask AI about this](#) ```sh curl --request DELETE \ "https://console.influxdata.com/api/v0/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables/{tableName}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204The cluster database table was successfully deleted 400Bad Request `code`requiredinteger `message`requiredstring 401Unauthorized `code`requiredinteger `message`requiredstring 403Forbidden `code`requiredinteger `message`requiredstring 404Not Found `code`requiredinteger `message`requiredstring 500Internal Server Error `code`requiredinteger `message`requiredstring PUT`/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables/{tableName}/rename` ### Rename a database table #### Parameters ##### Path parameters `accountId`requiredstring The ID of the account that the database table belongs to `clusterId`requiredstring The ID of the cluster that the database table belongs to `databaseName`requiredstring The name of the database that the database table belongs to `tableName`requiredstring The name of the database table to rename #### Request bodyrequired Content-Type:`application/json` `name`requiredstring The name of the cluster database table Example request[Ask AI about this](#) ```sh curl --request PUT \ "https://console.influxdata.com/api/v0/accounts/{accountId}/clusters/{clusterId}/databases/{databaseName}/tables/{tableName}/rename" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "name": "NAME" }' ``` #### Responses 200The cluster database table was successfully renamed `accountId`requiredstring \ `clusterId`requiredstring \ `databaseName`requiredstring The name of the cluster database `id`requiredinteger \ The ID of the table `name`requiredstring The name of the cluster database table `partitionTemplate`object[] A template for partitioning a cluster database. Each partition template part is evaluated in sequence. The outputs from each part are concatenated with the`|` delimiter to form the final partition key. For example, using the partition template below: ```json [ { "type": "time", "value": "%Y" }, { "type": "tag", "value": "bananas" }, { "type": "tag", "value": "plátanos" }, { "type": "bucket", "value": { "tagName": "c", "numberOfBuckets": 10 } } ] ``` The following partition keys are derived: * `time=2023-01-01, a=bananas, b=plátanos, c=ananas` -\> `2023|bananas|plátanos|5` * `time=2023-01-01, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01, another=cat, b=plátanos` -\> `2023|!|plátanos|!` * `time=2023-01-01` -\> `2023|!|!|!` * `time=2023-01-01, a=cat|dog, b=!, c=!` -\> `2023|cat%7Cdog|%21|8` * `time=2023-01-01, a=%50, c=%50` -\> `2023|%2550|!|9` * `time=2023-01-01, a=, c=` -\> `2023|^|!|0` * `time=2023-01-01, a=` -\> `2023|#|!|!` * `time=2023-01-01, c=` -\> `2023|!|!|` When using the default partitioning template (YYYY-MM-DD) there is no encoding necessary, as the derived partition key contains a single part, and no reserved characters. [`TemplatePart::Bucket`] parts by definition will always be within the part length limit and contain no restricted characters so are also not percent-encoded and/or truncated. 400Bad Request `code`requiredinteger `message`requiredstring 401Unauthorized `code`requiredinteger `message`requiredstring 403Forbidden `code`requiredinteger `message`requiredstring 404Not Found `code`requiredinteger `message`requiredstring 409Conflict `code`requiredinteger `message`requiredstring 500Internal Server Error `code`requiredinteger `message`requiredstring #### Related * [Manage tables](/influxdb3/cloud-dedicated/admin/tables/) * [Create a table with custom partitioning](/influxdb3/cloud-dedicated/admin/tables/#create-a-table-with-custom-partitioning) * [Custom partitions](/influxdb3/cloud-dedicated/admin/custom-partitions/) * [InfluxDB 3 API client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/)