Class RemotesAPI

Remotes API

Index

Constructors

Methods

deleteRemoteConnectionByID getRemoteConnectionByID getRemoteConnections patchRemoteConnectionByID postRemoteConnection

Constructors

constructor

new RemotesAPI(influxDB: InfluxDB): RemotesAPI
Creates RemotesAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns RemotesAPI
- Defined in apis/src/generated/RemotesAPI.ts:42

Methods

deleteRemoteConnectionByID

deleteRemoteConnectionByID(
request: DeleteRemoteConnectionByIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteRemoteConnectionByID
Parameters
- request: DeleteRemoteConnectionByIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/RemotesAPI.ts:130

getRemoteConnectionByID

getRemoteConnectionByID(
request: GetRemoteConnectionByIDRequest,
requestOptions?: RequestOptions,
): Promise<RemoteConnection>
Retrieve a remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetRemoteConnectionByID
Parameters
- request: GetRemoteConnectionByIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<RemoteConnection>
promise of response
- Defined in apis/src/generated/RemotesAPI.ts:93

getRemoteConnections

getRemoteConnections(
request: GetRemoteConnectionsRequest,
requestOptions?: RequestOptions,
): Promise<RemoteConnections>
List all remote connections. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetRemoteConnections
Parameters
- request: GetRemoteConnectionsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<RemoteConnections>
promise of response
- Defined in apis/src/generated/RemotesAPI.ts:52

patchRemoteConnectionByID

patchRemoteConnectionByID(
request: PatchRemoteConnectionByIDRequest,
requestOptions?: RequestOptions,
): Promise<RemoteConnection>
Update a remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchRemoteConnectionByID
Parameters
- request: PatchRemoteConnectionByIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<RemoteConnection>
promise of response
- Defined in apis/src/generated/RemotesAPI.ts:111

postRemoteConnection

postRemoteConnection(
request: PostRemoteConnectionRequest,
requestOptions?: RequestOptions,
): Promise<RemoteConnection>
Register a new remote connection. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostRemoteConnection
Parameters
- request: PostRemoteConnectionRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<RemoteConnection>
promise of response
- Defined in apis/src/generated/RemotesAPI.ts:74