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

InfluxDB Bucket Schemas API

The Bucket Schemas API from InfluxDB — 2 operation(s) for bucket schemas.

InfluxDB Bucket Schemas API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Bucket Schemas. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.

This API exposes 4 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

4 operations 2 paths 9 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

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

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

Paths & Operations 4

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

Bucket Schemas 4
GET
/api/v2/buckets/{bucketID}/schema/measurements
List measurement schemas of a bucket
getMeasurementSchemas 4 params → 200400401404500
POST
/api/v2/buckets/{bucketID}/schema/measurements
Create a measurement schema for a bucket
createMeasurementSchema 3 params body → 201400401404500
GET
/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
Retrieve a measurement schema
getMeasurementSchema 4 params → 200401404500
PATCH
/api/v2/buckets/{bucketID}/schema/measurements/{measurementID}
Update a measurement schema
updateMeasurementSchema 4 params body → 200400401404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are MeasurementSchema (7 properties), Error (4 properties), MeasurementSchemaColumn (3 properties), MeasurementSchemaCreateRequest (2 properties). Each schema is shown below with its type and property counts.

ColumnSemanticType
string
ColumnDataType
string
MeasurementSchema
object
Definition of a measurement schema.
7 properties 5 required
ErrorCode
string
code is the machine-readable error code.
MeasurementSchemaUpdateRequest
object
Update an existing measurement schema
1 property 1 required
MeasurementSchemaCreateRequest
object
Create a new measurement schema.
2 properties 2 required
MeasurementSchemaList
object
A list of measurement schemas returning summary information
1 property 1 required
Error
object
4 properties 1 required
MeasurementSchemaColumn
object
Definition of a measurement schema column.
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-bucket-schemas-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Checks API
InfluxDB Config API
InfluxDB Dashboards API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API
InfluxDB Legacy Authorizations API