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

The Labels API from InfluxDB — 2 operation(s) for labels.

InfluxDB Labels 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 Labels. 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 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0.

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

5 operations 2 paths 10 schemas 1 DELETE2 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 Labels 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 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.

Labels 5
GET
/api/v2/labels
List all labels
GetLabels 2 params → 200500default
POST
/api/v2/labels
Create a label
PostLabels body → 201500default
DELETE
/api/v2/labels/{labelID}
Delete a label
DeleteLabelsID 2 params → 204401404500default
GET
/api/v2/labels/{labelID}
Retrieve a label
GetLabelsID 2 params → 200500default
PATCH
/api/v2/labels/{labelID}
Update a label
PatchLabelsID 2 params body → 200401404500default

Schemas 10

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

Links
object
URI pointers for additional paged results.
3 properties 1 required
Link
string
URI of resource.
LabelUpdate
object
2 properties
LabelsResponse
object
2 properties
ErrorCode
string
code is the machine-readable error code.
LabelResponse
object
2 properties
Labels
array
Label
object
4 properties
LabelCreateRequest
object
3 properties 2 required
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-labels-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas 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 Legacy Authorizations API