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

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

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

Tagged areas include Labels. 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 9 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 9 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 Labels 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.

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

Schemas 9

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

Error
object
4 properties 1 required
LabelCreateRequest
object
3 properties 2 required
LabelUpdate
object
2 properties
Labels
array
Links
object
URI pointers for additional paged results.
3 properties 1 required
LabelsResponse
object
2 properties
Link
string
URI of resource.
LabelResponse
object
2 properties
Label
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-labels-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 DBRPs API
InfluxData Debug API
InfluxData Delete API