Class SourcesAPI

Sources API

Index

Constructors

Methods

deleteSourcesID getSources getSourcesID getSourcesIDBuckets getSourcesIDHealth patchSourcesID postSources

Constructors

constructor

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

Methods

deleteSourcesID

deleteSourcesID(
request: DeleteSourcesIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a source. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteSourcesID
Parameters
- request: DeleteSourcesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:132

getSources

getSources(
request?: GetSourcesRequest,
requestOptions?: RequestOptions,
): Promise<Sources>
List all sources. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetSources
Parameters
- Optionalrequest: GetSourcesRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Sources>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:58

getSourcesID

getSourcesID(
request: GetSourcesIDRequest,
requestOptions?: RequestOptions,
): Promise<Source>
Retrieve a source. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetSourcesID
Parameters
- request: GetSourcesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Source>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:95

getSourcesIDBuckets

getSourcesIDBuckets(
request: GetSourcesIDBucketsRequest,
requestOptions?: RequestOptions,
): Promise<Buckets>
Get buckets in a source. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetSourcesIDBuckets
Parameters
- request: GetSourcesIDBucketsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Buckets>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:168

getSourcesIDHealth

getSourcesIDHealth(
request: GetSourcesIDHealthRequest,
requestOptions?: RequestOptions,
): Promise<HealthCheck>
Get the health of a source. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetSourcesIDHealth
Parameters
- request: GetSourcesIDHealthRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<HealthCheck>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:150

patchSourcesID

patchSourcesID(
request: PatchSourcesIDRequest,
requestOptions?: RequestOptions,
): Promise<Source>
Update a Source. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchSourcesID
Parameters
- request: PatchSourcesIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Source>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:113

postSources

postSources(
request: PostSourcesRequest,
requestOptions?: RequestOptions,
): Promise<Source>
Create a source. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostSources
Parameters
- request: PostSourcesRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Source>
promise of response
- Defined in apis/src/generated/SourcesAPI.ts:76