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 Bucket Schemas API

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

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

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

This API exposes 4 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.

4 operations 2 paths 8 schemas 2 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 Bucket Schemas 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 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
/buckets/{bucketID}/schema/measurements
List measurement schemas of a bucket
getMeasurementSchemas 4 params → 200400401404500
POST
/buckets/{bucketID}/schema/measurements
Create a measurement schema for a bucket
createMeasurementSchema 3 params body → 201400401404500
GET
/buckets/{bucketID}/schema/measurements/{measurementID}
Retrieve a measurement schema
getMeasurementSchema 4 params → 200401404500
PATCH
/buckets/{bucketID}/schema/measurements/{measurementID}
Update a measurement schema
updateMeasurementSchema 4 params body → 200400401404500

Schemas 8

The contract defines 8 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.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Buckets 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