Class ChecksAPI

Checks API

Index

Constructors

Methods

createCheck deleteChecksID deleteChecksIDLabelsID getChecks getChecksID getChecksIDLabels getChecksIDQuery patchChecksID postChecksIDLabels putChecksID

Constructors

constructor

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

Methods

createCheck

createCheck(
request: CreateCheckRequest,
requestOptions?: RequestOptions,
): Promise<CheckDiscriminator>
Add new check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/CreateCheck
Parameters
- request: CreateCheckRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<CheckDiscriminator>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:112

deleteChecksID

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

deleteChecksIDLabelsID

deleteChecksIDLabelsID(
request: DeleteChecksIDLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete label from a check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteChecksIDLabelsID
Parameters
- request: DeleteChecksIDLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:242

getChecks

getChecks(
request: GetChecksRequest,
requestOptions?: RequestOptions,
): Promise<Checks>
List all checks. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetChecks
Parameters
- request: GetChecksRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<Checks>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:90

getChecksID

getChecksID(
request: GetChecksIDRequest,
requestOptions?: RequestOptions,
): Promise<CheckDiscriminator>
Retrieve a check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetChecksID
Parameters
- request: GetChecksIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<CheckDiscriminator>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:131

getChecksIDLabels

getChecksIDLabels(
request: GetChecksIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelsResponse>
List all labels for a check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetChecksIDLabels
Parameters
- request: GetChecksIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelsResponse>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:205

getChecksIDQuery

getChecksIDQuery(
request: GetChecksIDQueryRequest,
requestOptions?: RequestOptions,
): Promise<FluxResponse>
Retrieve a check query. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetChecksIDQuery
Parameters
- request: GetChecksIDQueryRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<FluxResponse>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:260

patchChecksID

patchChecksID(
request: PatchChecksIDRequest,
requestOptions?: RequestOptions,
): Promise<CheckDiscriminator>
Update a check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchChecksID
Parameters
- request: PatchChecksIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<CheckDiscriminator>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:168

postChecksIDLabels

postChecksIDLabels(
request: PostChecksIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Add a label to a check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostChecksIDLabels
Parameters
- request: PostChecksIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:223

putChecksID

putChecksID(
request: PutChecksIDRequest,
requestOptions?: RequestOptions,
): Promise<CheckDiscriminator>
Update a check. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PutChecksID
Parameters
- request: PutChecksIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<CheckDiscriminator>
promise of response
- Defined in apis/src/generated/ChecksAPI.ts:149

Class ChecksAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ChecksAPI

Methods

createCheck

Parameters

Returns Promise<CheckDiscriminator>

deleteChecksID

Parameters

Returns Promise<void>

deleteChecksIDLabelsID

Parameters

Returns Promise<void>

getChecks

Parameters

Returns Promise<Checks>

getChecksID

Parameters

Returns Promise<CheckDiscriminator>

getChecksIDLabels

Parameters

Returns Promise<LabelsResponse>

getChecksIDQuery

Parameters

Returns Promise<FluxResponse>

patchChecksID

Parameters

Returns Promise<CheckDiscriminator>

postChecksIDLabels

Parameters

Returns Promise<LabelResponse>

putChecksID

Parameters

Returns Promise<CheckDiscriminator>

Settings

On This Page