Table

Download InfluxDB 3 Cloud API Spec
Manage table schemas in an InfluxDB 3 Cloud database.
POST /api/v3/configure/table

Create a table

Creates a new table within a database.

Request body required

Content-Type: application/json
db required string
fields required object[]
name required string
type required string
Allowed: utf8 , int64 , uint64 , float64 , bool
retention_period string
The retention period for the table. Specifies how long data in this table should be retained. Use duration format (for example, “1d”, “1h”, “30m”, “7d”).
Example: "30d"
table required string
tags required string[]
Example request Ask AI about this
curl --request POST \
  "https://cluster-host.a.influxdb.io/api/v3/configure/table" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "db": "DB",
  "fields": [
    {
      "name": "NAME",
      "type": "utf8"
    }
  ],
  "retention_period": "30d",
  "table": "TABLE",
  "tags": [
    "TAGS"
  ]
}'

Responses

200 Success. The table has been created.
400 Bad request.
401 Unauthorized access.
data object
error string
404 Database not found.
DELETE /api/v3/configure/table

Delete a table

Soft deletes a table. The table is scheduled for deletion and unavailable for querying. Use the hard_delete_at parameter to schedule a hard deletion. Use the data_only parameter to delete data while preserving the table schema and resources.

Deleting a table cannot be undone

Deleting a table is a destructive action. Once a table is deleted, data stored in that table cannot be recovered.

Parameters

Query parameters
db required string
The name of the database.
table required string
data_only boolean
Delete only data while preserving the table schema and all associated resources (last value caches, distinct value caches). When false (default), the entire table is deleted.
hard_delete_at string <date-time>

Schedule the table for hard deletion at the specified time. If not provided, the table will be soft deleted. Use ISO 8601 format (for example, “2025-12-31T23:59:59Z”).

Also accepts special string values:

  • now — hard delete immediately
  • never — soft delete only (default behavior)
  • default — use the system default hard deletion time
Example request Ask AI about this
curl --request DELETE \
  "https://cluster-host.a.influxdb.io/api/v3/configure/table?db=DB&table=TABLE" \
  --header "Authorization: Bearer INFLUX_TOKEN"

Responses

200 Success (no content). The table has been deleted.
401 Unauthorized access.
data object
error string
404 Table not found.

Was this page helpful?

Thank you for your feedback!