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

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

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

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

This API exposes 9 operations across 4 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

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

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

Schemas 14

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-variables-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