Class TemplatesAPI

Templates API

Index

Constructors

Methods

applyTemplate exportTemplate

Constructors

constructor

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

Methods

applyTemplate

applyTemplate(
request: ApplyTemplateRequest,
requestOptions?: RequestOptions,
): Promise<TemplateSummary>
Apply or dry-run a template. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/ApplyTemplate
Parameters
- request: ApplyTemplateRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<TemplateSummary>
promise of response
- Defined in apis/src/generated/TemplatesAPI.ts:41

exportTemplate

exportTemplate(
request: ExportTemplateRequest,
requestOptions?: RequestOptions,
): Promise<Template>
Export a new template. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/ExportTemplate
Parameters
- request: ExportTemplateRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Template>
promise of response
- Defined in apis/src/generated/TemplatesAPI.ts:60