--- title: DBRPs description: Manage database and retention policy (DBRP) mappings that route InfluxDB v1-compatible requests to InfluxDB Cloud buckets. url: https://docs.influxdata.com/influxdb/cloud/api/dbrps/ estimated_tokens: 20546 product: InfluxDB Cloud (TSM) version: cloud --- [Download InfluxDB Cloud (TSM) API Spec](/openapi/influxdb-cloud-v2-api.yml) Manage database and retention policy (DBRP) mappings that route InfluxDB v1-compatible requests to InfluxDB Cloud buckets. GET `/api/v2/dbrps` ### List database retention policy mappings Lists database retention policy (DBRP) mappings. #### Related guide - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) #### Parameters ##### Query parameters `orgID` string An organization ID. Only returns DBRP mappings for the specified organization. `org` string An organization name. Only returns DBRP mappings for the specified organization. `id` string A DBPR mapping ID. Only returns the specified DBRP mapping. `bucketID` string A bucket ID. Only returns DBRP mappings that belong to the specified bucket. `default` boolean Specifies filtering on default `db` string A database. Only returns DBRP mappings that belong to the 1.x database. `rp` string A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp). Specifies the 1.x retention policy to filter on. ##### Header parameters `Zap-Trace-Span` string OpenTracing span context Example request [Ask AI about this](#) ```sh curl --request GET \ "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dbrps" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200 Success. The response body contains a list of database retention policy mappings. `content` object\[\] 400 Bad request. The request has one or more invalid parameters. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 401 Unauthorized. The error may indicate one of the following: - The `Authorization: Token` header is missing or malformed. - The API token value is missing from the header. - The token doesn’t have sufficient permissions to write to this organization and bucket. `code` string The HTTP status code description. Default is `unauthorized`. Allowed: `unauthorized` `message` string A human-readable message that may contain detail about the error. 500 Internal server error. The server encountered an unexpected situation. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. default Unexpected error `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. POST `/api/v2/dbrps` ### Add a database retention policy mapping Creates a database retention policy (DBRP) mapping and returns the mapping. Use this endpoint to add InfluxDB 1.x API compatibility to your InfluxDB Cloud or InfluxDB OSS 2.x buckets. Your buckets must contain a DBRP mapping in order to query and write using the InfluxDB 1.x API. object. #### Related guide - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) #### Parameters ##### Header parameters `Zap-Trace-Span` string OpenTracing span context #### Request body required The database retention policy mapping to add. Note that *`retention_policy`* is a required parameter in the request body. The value of *`retention_policy`* can be any arbitrary `string` name or value, with the default value commonly set as `autogen`. The value of *`retention_policy`* isn’t a [retention\_policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) Content-Type: `application/json` `bucketID` required string A bucket ID. Identifies the bucket used as the target for the translation. `database` required string A database name. Identifies the InfluxDB v1 database. `default` boolean Set to `true` to use this DBRP mapping as the default retention policy for the database (specified by the `database` property’s value). `org` string An organization name. Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. `orgID` string An organization ID. Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. `retention_policy` required string A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) name. Identifies the InfluxDB v1 retention policy mapping. Example request [Ask AI about this](#) ```sh curl --request POST \ "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dbrps" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "bucketID": "BUCKETID", "database": "DATABASE", "default": false, "org": "ORG", "orgID": "ORGID", "retention_policy": "RETENTION_POLICY" }' ``` #### Responses 201 Created. The response body contains the database retention policy mapping. `bucketID` required string A bucket ID. Identifies the bucket used as the target for the translation. `database` required string A database name. Identifies the InfluxDB v1 database. `default` required boolean If set to `true`, this DBRP mapping is the default retention policy for the database (specified by the `database` property’s value). `id` required string The resource ID that InfluxDB uses to uniquely identify the database retention policy (DBRP) mapping. `links` string `orgID` required string An organization ID. Identifies the [organization](/influxdb/cloud/reference/glossary/#organization) that owns the mapping. `retention_policy` required string A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) name. Identifies the InfluxDB v1 retention policy mapping. `virtual` boolean Indicates an autogenerated, virtual mapping based on the bucket name. Currently only available in OSS. 400 Bad request. The mapping in the request has one or more invalid IDs. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 401 Unauthorized. The error may indicate one of the following: - The `Authorization: Token` header is missing or malformed. - The API token value is missing from the header. - The token doesn’t have sufficient permissions to write to this organization and bucket. `code` string The HTTP status code description. Default is `unauthorized`. Allowed: `unauthorized` `message` string A human-readable message that may contain detail about the error. 404 Not found. A requested resource was not found. The response body contains the requested resource type and the name value (if you passed it)–for example: - `"organization name \"my-org\" not found"` - `"organization not found"`: indicates you passed an ID that did not match an organization. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 500 Internal server error. The server encountered an unexpected situation. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. default Unexpected error `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. GET `/api/v2/dbrps/{dbrpID}` ### Retrieve a database retention policy mapping Retrieves the specified retention policy (DBRP) mapping. #### Related guide - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) #### Parameters ##### Path parameters `dbrpID` required string A DBRP mapping ID. Specifies the DBRP mapping. ##### Query parameters `orgID` string An organization ID. Specifies the organization that owns the DBRP mapping. `org` string An organization name. Specifies the organization that owns the DBRP mapping. ##### Header parameters `Zap-Trace-Span` string OpenTracing span context Example request [Ask AI about this](#) ```sh curl --request GET \ "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dbrps/{dbrpID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 200 Success. The response body contains the DBRP mapping. `content` string 400 Bad Request. Query parameters contain invalid values. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 401 Unauthorized. The error may indicate one of the following: - The `Authorization: Token` header is missing or malformed. - The API token value is missing from the header. - The token doesn’t have sufficient permissions to write to this organization and bucket. `code` string The HTTP status code description. Default is `unauthorized`. Allowed: `unauthorized` `message` string A human-readable message that may contain detail about the error. 404 Not found. A requested resource was not found. The response body contains the requested resource type and the name value (if you passed it)–for example: - `"organization name \"my-org\" not found"` - `"organization not found"`: indicates you passed an ID that did not match an organization. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 500 Internal server error. The server encountered an unexpected situation. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. default Unexpected error `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. PATCH `/api/v2/dbrps/{dbrpID}` ### Update a database retention policy mapping #### Parameters ##### Path parameters `dbrpID` required string A DBRP mapping ID. Specifies the DBRP mapping. ##### Query parameters `orgID` string An organization ID. Specifies the organization that owns the DBRP mapping. `org` string An organization name. Specifies the organization that owns the DBRP mapping. ##### Header parameters `Zap-Trace-Span` string OpenTracing span context #### Request body required Updates the database retention policy (DBRP) mapping and returns the mapping. Use this endpoint to modify the *retention policy* (`retention_policy` property) of a DBRP mapping. #### Related guide - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) Content-Type: `application/json` `default` boolean Set to `true` to use this DBRP mapping as the default retention policy for the database (specified by the `database` property’s value). To remove the default mapping, set to `false`. `retention_policy` string A [retention policy](/influxdb/cloud/reference/glossary/#retention-policy-rp) name. Identifies the InfluxDB v1 retention policy mapping. Example request [Ask AI about this](#) ```sh curl --request PATCH \ "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dbrps/{dbrpID}" \ --header "Authorization: Bearer INFLUX_TOKEN" \ --header "Content-Type: application/json" \ --data-raw '{ "default": false, "retention_policy": "RETENTION_POLICY" }' ``` #### Responses 200 An updated mapping `content` string 400 Bad Request. Query parameters contain invalid values. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 401 Unauthorized. The error may indicate one of the following: - The `Authorization: Token` header is missing or malformed. - The API token value is missing from the header. - The token doesn’t have sufficient permissions to write to this organization and bucket. `code` string The HTTP status code description. Default is `unauthorized`. Allowed: `unauthorized` `message` string A human-readable message that may contain detail about the error. 404 Not found. A requested resource was not found. The response body contains the requested resource type and the name value (if you passed it)–for example: - `"organization name \"my-org\" not found"` - `"organization not found"`: indicates you passed an ID that did not match an organization. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 500 Internal server error. The server encountered an unexpected situation. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. default Unexpected error `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. DELETE `/api/v2/dbrps/{dbrpID}` ### Delete a database retention policy Deletes the specified database retention policy (DBRP) mapping. #### Related guide - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/) #### Parameters ##### Path parameters `dbrpID` required string A DBRP mapping ID. Only returns the specified DBRP mapping. ##### Query parameters `orgID` string An organization ID. Specifies the organization that owns the DBRP mapping. `org` string An organization name. Specifies the organization that owns the DBRP mapping. ##### Header parameters `Zap-Trace-Span` string OpenTracing span context Example request [Ask AI about this](#) ```sh curl --request DELETE \ "https://us-east-1-1.aws.cloud2.influxdata.com/api/v2/dbrps/{dbrpID}" \ --header "Authorization: Bearer INFLUX_TOKEN" ``` #### Responses 204 Success. The delete is accepted. 400 Bad Request. Query parameters contain invalid values. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 401 Unauthorized. The error may indicate one of the following: - The `Authorization: Token` header is missing or malformed. - The API token value is missing from the header. - The token doesn’t have sufficient permissions to write to this organization and bucket. `code` string The HTTP status code description. Default is `unauthorized`. Allowed: `unauthorized` `message` string A human-readable message that may contain detail about the error. 404 Not found. A requested resource was not found. The response body contains the requested resource type and the name value (if you passed it)–for example: - `"organization name \"my-org\" not found"` - `"organization not found"`: indicates you passed an ID that did not match an organization. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. 500 Internal server error. The server encountered an unexpected situation. `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. default Unexpected error `code` required string code is the machine-readable error code. Allowed: `internal error` , `not implemented` , `not found` , `conflict` , `invalid` , `unprocessable entity` , `empty value` , `unavailable` , `forbidden` , `too many requests` , `unauthorized` , `method not allowed` , `request too large` , `unsupported media type` `err` string Stack of errors that occurred during processing of the request. Useful for debugging. `message` string Human-readable message. `op` string Describes the logical code operation when the error occurred. Useful for debugging. #### Related - [Database and retention policy mapping](/influxdb/cloud/reference/api/influxdb-1x/dbrp/)