Home > @influxdata/influxdb-client-apis > VariablesAPI

VariablesAPI class

Variables API

Signature:

declare class VariablesAPI 

Constructors

Constructor	Modifiers	Description
(constructor)(influxDB)		Creates VariablesAPI

Methods

Method	Modifiers	Description
deleteVariablesID(request, requestOptions)		Delete a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteVariablesID
deleteVariablesIDLabelsID(request, requestOptions)		Delete a label from a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteVariablesIDLabelsID
getVariables(request, requestOptions)		List all variables. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetVariables
getVariablesID(request, requestOptions)		Retrieve a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetVariablesID
getVariablesIDLabels(request, requestOptions)		List all labels for a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetVariablesIDLabels
patchVariablesID(request, requestOptions)		Update a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchVariablesID
postVariables(request, requestOptions)		Create a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostVariables
postVariablesIDLabels(request, requestOptions)		Add a label to a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostVariablesIDLabels
putVariablesID(request, requestOptions)		Replace a variable. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PutVariablesID