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

The Variables API from InfluxDB — 4 operation(s) for variables.

InfluxDB Variables 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 Variables. 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 9 operations across 4 paths, and defines 15 schemas. It is described by OpenAPI 3.0.0.

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

9 operations 4 paths 15 schemas 2 DELETE3 GET1 PATCH2 POST1 PUT

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 Variables 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 9

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

Variables 9
GET
/api/v2/variables
List all variables
GetVariables 3 params → 200400default
POST
/api/v2/variables
Create a variable
PostVariables 1 param body → 201default
DELETE
/api/v2/variables/{variableID}
Delete a variable
DeleteVariablesID 2 params → 204default
GET
/api/v2/variables/{variableID}
Retrieve a variable
GetVariablesID 2 params → 200404default
PATCH
/api/v2/variables/{variableID}
Update a variable
PatchVariablesID 2 params body → 200default
PUT
/api/v2/variables/{variableID}
Replace a variable
PutVariablesID 2 params body → 200default
GET
/api/v2/variables/{variableID}/labels
List all labels for a variable
GetVariablesIDLabels 2 params → 200default
POST
/api/v2/variables/{variableID}/labels
Add a label to a variable
PostVariablesIDLabels 2 params body → 201default
DELETE
/api/v2/variables/{variableID}/labels/{labelID}
Delete a label from a variable
DeleteVariablesIDLabelsID 3 params → 204404default

Schemas 15

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

ConstantVariableProperties
object
2 properties
Links
object
URI pointers for additional paged results.
3 properties 1 required
QueryVariableProperties
object
2 properties
VariableProperties
object
Link
string
URI of resource.
LabelsResponse
object
2 properties
ErrorCode
string
code is the machine-readable error code.
Variable
object
11 properties 3 required
MapVariableProperties
object
2 properties
LabelResponse
object
2 properties
Variables
object
1 property
Label
object
4 properties
Labels
array
LabelMapping
object
A label mapping contains a label ID to attach to a resource.
1 property 1 required
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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