---
title: Databases
description: Create and manage databases in an InfluxDB 3 Clustered cluster, including setting retention periods and custom partition templates.
url: https://docs.influxdata.com/influxdb3/clustered/api/management-api/databases/
estimated_tokens: 1620
publisher: InfluxData
canonical: https://docs.influxdata.com/influxdb3/clustered/api/management-api/databases/
---

[Download Clustered Management API Spec](/openapi/influxdb-clustered-management-api.yml)

Create and manage databases in an InfluxDB 3 Clustered cluster, including setting retention periods and custom partition templates.

GET`/databases`

### Get all databases for a cluster

Example request[Ask AI about this](#)

```sh
curl --request GET \
  "https://console.influxdata.com/api/v0/databases" \
  --header "Authorization: Bearer INFLUX_TOKEN"
```

#### Responses

200The cluster databases were successfully retrieved

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

POST`/databases`

### Create a database

#### Request bodyrequired

Content-Type:`application/json`

`maxColumnsPerTable`string

`maxTables`string

`name`requiredstring

`partitionTemplate`string

`retentionPeriod`string

Example request[Ask AI about this](#)

```sh
curl --request POST \
  "https://console.influxdata.com/api/v0/databases" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "maxColumnsPerTable": 200,
  "maxTables": 500,
  "name": "NAME",
  "partitionTemplate": [],
  "retentionPeriod": 0
}'
```

#### Responses

200The cluster database was successfully created

`maxColumnsPerTable`requiredstring

`maxTables`requiredstring

`name`requiredstring

`partitionTemplate`string

`retentionPeriod`requiredstring

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`/databases/{databaseId}/undelete`

### Undelete a database

Restores a previously deleted database.

This operation can only be performed on databases that have been soft-deleted and are still within the recovery window.

#### Parameters

##### Path parameters

`databaseId`requiredstring

The ID of the database to undelete

Example request[Ask AI about this](#)

```sh
curl --request PUT \
  "https://console.influxdata.com/api/v0/databases/{databaseId}/undelete" \
  --header "Authorization: Bearer INFLUX_TOKEN"
```

#### Responses

200The cluster database was successfully undeleted

`id`requiredstring

The ID of the database

`maxColumnsPerTable`requiredstring

`maxTables`requiredstring

`name`requiredstring

`partitionTemplate`string

`retentionPeriod`string

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

PATCH`/databases/{databaseName}`

### Update a database

#### Parameters

##### Path parameters

`databaseName`requiredstring

The name of the database to update

#### Request bodyrequired

Content-Type:`application/json`

`maxColumnsPerTable`string

`maxTables`string

`retentionPeriod`string

Example request[Ask AI about this](#)

```sh
curl --request PATCH \
  "https://console.influxdata.com/api/v0/databases/{databaseName}" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "maxColumnsPerTable": 200,
  "maxTables": 500,
  "retentionPeriod": 0
}'
```

#### Responses

200The cluster database was successfully updated.

`maxColumnsPerTable`requiredstring

`maxTables`requiredstring

`name`requiredstring

`retentionPeriod`requiredstring

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`/databases/{databaseName}`

### Delete a database

#### Parameters

##### Path parameters

`databaseName`requiredstring

The name of the database to delete

Example request[Ask AI about this](#)

```sh
curl --request DELETE \
  "https://console.influxdata.com/api/v0/databases/{databaseName}" \
  --header "Authorization: Bearer INFLUX_TOKEN"
```

#### Responses

204No Content

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`/databases/{databaseName}/rename`

### Rename a database

Renames an existing database.

This operation can only be performed on databases that are currently active.

#### Parameters

##### Path parameters

`databaseName`requiredstring

The name of the database to rename

#### Request bodyrequired

Content-Type:`application/json`

`name`requiredstring

Example request[Ask AI about this](#)

```sh
curl --request PUT \
  "https://console.influxdata.com/api/v0/databases/{databaseName}/rename" \
  --header "Authorization: Bearer INFLUX_TOKEN" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "NAME"
}'
```

#### Responses

200The cluster database was successfully renamed

`id`requiredstring

The ID of the database

`maxColumnsPerTable`requiredstring

`maxTables`requiredstring

`name`requiredstring

`partitionTemplate`string

`retentionPeriod`string

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 databases](/influxdb3/clustered/admin/databases/)
* [Custom partitions](/influxdb3/clustered/admin/custom-partitions/)
* [InfluxDB 3 API client libraries](/influxdb3/clustered/reference/client-libraries/v3/)