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

RemotesAPI class

Remotes API

Signature:

declare class RemotesAPI 

Constructors

Constructor	Modifiers	Description
(constructor)(influxDB)		Creates RemotesAPI

Methods

Method	Modifiers	Description
deleteRemoteConnectionByID(request, requestOptions)		Delete a remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteRemoteConnectionByID
getRemoteConnectionByID(request, requestOptions)		Retrieve a remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetRemoteConnectionByID
getRemoteConnections(request, requestOptions)		List all remote connections. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetRemoteConnections
patchRemoteConnectionByID(request, requestOptions)		Update a remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchRemoteConnectionByID
postRemoteConnection(request, requestOptions)		Register a new remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRemoteConnection