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 Buckets API

Store your data in InfluxDB [buckets](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#bucket).A bucket is a named location where time series data is stored. All bucketshave a [retention period](https://docs.influxdata.com/influxdb/cloud/reference/glossary/#retention-period),a duration of time that each data point persists. InfluxDB drops allpoints with timestamps older than the bucket’s retention period.A bucket belongs to an organization.### Related guides- [Manage buckets](https://docs.influxdata.com/influxdb/cloud/organizations/buckets/)

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

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

This API exposes 15 operations across 9 paths, and defines 23 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

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

15 operations 9 paths 23 schemas 4 DELETE6 GET1 PATCH4 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 Buckets 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 15

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

Buckets 15

Store your data in InfluxDB [buckets](https://docs.influxdata.com/influxdb/cloud/reference/glossary/bucket). A bucket is a named location where time series data is stored. All buc…

GET
/buckets
List buckets
GetBuckets 8 params → 200401500default
POST
/buckets
Create a bucket
PostBuckets 1 param body → 201400401403422500default
GET
/buckets/{bucketID}
Retrieve a bucket
GetBucketsID 2 params → 200401404500default
PATCH
/buckets/{bucketID}
Update a bucket
PatchBucketsID 2 params body → 200400401403404500default
DELETE
/buckets/{bucketID}
Delete a bucket
DeleteBucketsID 2 params → 204400401404500default
GET
/buckets/{bucketID}/labels
List all labels for a bucket
GetBucketsIDLabels 2 params → 200400401404500default
POST
/buckets/{bucketID}/labels
Add a label to a bucket
PostBucketsIDLabels 2 params body → 201400401404422500default
DELETE
/buckets/{bucketID}/labels/{labelID}
Delete a label from a bucket
DeleteBucketsIDLabelsID 3 params → 204404default
GET
/buckets/{bucketID}/members
List all users with member privileges for a bucket
GetBucketsIDMembers 2 params → 200400401404500default
POST
/buckets/{bucketID}/members
Add a member to a bucket
PostBucketsIDMembers 2 params body → 201400401404500default
DELETE
/buckets/{bucketID}/members/{userID}
Remove a member from a bucket
DeleteBucketsIDMembersID 3 params → 204401404500default
GET
/buckets/{bucketID}/owners
List all owners of a bucket
GetBucketsIDOwners 2 params → 200400401404500default
POST
/buckets/{bucketID}/owners
Add an owner to a bucket
PostBucketsIDOwners 2 params body → 201400401404500default
DELETE
/buckets/{bucketID}/owners/{userID}
Remove an owner from a bucket
DeleteBucketsIDOwnersID 3 params → 204401404500default
GET
/sources/{sourceID}/buckets
Get buckets in a source
GetSourcesIDBuckets 3 params → 200404default

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are Bucket (12 properties), PostBucketRequest (6 properties), Error (4 properties), Label (4 properties). Each schema is shown below with its type and property counts.

RetentionRule
object
3 properties 1 required
Bucket
object
12 properties 2 required
AddResourceMemberRequestBody
object
2 properties 1 required
Link
string
URI of resource.
ResourceMembers
object
2 properties
Links
object
URI pointers for additional paged results.
3 properties 1 required
ResourceMember
PatchRetentionRule
object
3 properties 1 required
SchemaType
string
Label
object
4 properties
ResourceOwners
object
2 properties
RetentionRules
array
Retention rules to expire or retain data. The InfluxDB /api/v2 API uses RetentionRules to configure the [retention period](https://docs.influxdata.com/influxdb…
LabelMapping
object
A label mapping contains a label ID to attach to a resource.
1 property 1 required
Labels
array
UserResponse
object
4 properties 1 required
Buckets
object
2 properties
PatchBucketRequest
object
An object that contains updated bucket properties to apply.
3 properties
ResourceOwner
LabelsResponse
object
2 properties
PatchRetentionRules
array
Updates to rules to expire or retain data. No rules means no updates.
PostBucketRequest
object
6 properties 2 required
LabelResponse
object
2 properties
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-buckets-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

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