Class SetupAPI

Setup API

Index

Constructors

Methods

getSetup postSetup

Constructors

constructor

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

Methods

getSetup

getSetup(
request?: GetSetupRequest,
requestOptions?: RequestOptions,
): Promise<IsOnboarding>
Check if database has default user, org, bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetSetup
Parameters
- Optionalrequest: GetSetupRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<IsOnboarding>
promise of response
- Defined in apis/src/generated/SetupAPI.ts:31

postSetup

postSetup(
request: PostSetupRequest,
requestOptions?: RequestOptions,
): Promise<OnboardingResponse>
Set up initial user, org and bucket. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostSetup
Parameters
- request: PostSetupRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<OnboardingResponse>
promise of response
- Defined in apis/src/generated/SetupAPI.ts:44