Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData DBRPs API

The InfluxDB 1.x data model includes [databases](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#database)and [retention policies](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/#retention-policy-rp).InfluxDB 2.x replaces databases and retention policies with buckets.To support InfluxDB 1.x query and write patterns in InfluxDB 2.x,databases and retention policies are mapped to buckets using thedatabase and retention policy (DBRP) mapping service.The DBRP mapping service uses the database and retention policyspecified in 1.x compatibility API requests to route operations to a bucket.### Related guides- [Database and retention policy mapping](https://docs.influxdata.com/influxdb/cloud/reference/api/influxdb-1x/dbrp/)

InfluxData DBRPs API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DBRPs. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData DBRPs API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

DBRPs 5

The InfluxDB 1.x data model includes [databases](https://docs.influxdata.com/influxdb/v1.8/concepts/glossary/database) and [retention policies](https://docs.influxdata.com/influxd…

GET
/dbrps
List database retention policy mappings
GetDBRPs 8 params → 200400401500default
POST
/dbrps
Add a database retention policy mapping
PostDBRP 1 param body → 201400401404500default
GET
/dbrps/{dbrpID}
Retrieve a database retention policy mapping
GetDBRPsID 4 params → 200400401404500default
PATCH
/dbrps/{dbrpID}
Update a database retention policy mapping
PatchDBRPID 4 params body → 200400401404500default
DELETE
/dbrps/{dbrpID}
Delete a database retention policy
DeleteDBRPID 4 params → 204400401404500default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are DBRP (8 properties), DBRPCreate (6 properties), Error (4 properties), Links (3 properties). Each schema is shown below with its type and property counts.

DBRP
object
8 properties 6 required
DBRPs
object
1 property
DBRPUpdate
object
2 properties
DBRPCreate
object
6 properties 3 required
DBRPGet
object
1 property
Link
string
URI of resource.
Error
object
4 properties 1 required
Links
object
URI pointers for additional paged results.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-dbrps-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData Debug API
InfluxData Delete API
InfluxData Health API