Class ScrapersAPI

Scrapers API

Index

Constructors

Methods

deleteScrapersID deleteScrapersIDLabelsID deleteScrapersIDMembersID deleteScrapersIDOwnersID getScrapers getScrapersID getScrapersIDLabels getScrapersIDMembers getScrapersIDOwners patchScrapersID postScrapers postScrapersIDLabels postScrapersIDMembers postScrapersIDOwners

Constructors

constructor

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

Methods

deleteScrapersID

deleteScrapersID(
request: DeleteScrapersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersID
Parameters
- request: DeleteScrapersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:193

deleteScrapersIDLabelsID

deleteScrapersIDLabelsID(
request: DeleteScrapersIDLabelsIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Delete a label from a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersIDLabelsID
Parameters
- request: DeleteScrapersIDLabelsIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:248

deleteScrapersIDMembersID

deleteScrapersIDMembersID(
request: DeleteScrapersIDMembersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove a member from a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersIDMembersID
Parameters
- request: DeleteScrapersIDMembersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:303

deleteScrapersIDOwnersID

deleteScrapersIDOwnersID(
request: DeleteScrapersIDOwnersIDRequest,
requestOptions?: RequestOptions,
): Promise<void>
Remove an owner from a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersIDOwnersID
Parameters
- request: DeleteScrapersIDOwnersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<void>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:358

getScrapers

getScrapers(
request?: GetScrapersRequest,
requestOptions?: RequestOptions,
): Promise<ScraperTargetResponses>
List all scraper targets. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapers
Parameters
- Optionalrequest: GetScrapersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ScraperTargetResponses>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:114

getScrapersID

getScrapersID(
request: GetScrapersIDRequest,
requestOptions?: RequestOptions,
): Promise<ScraperTargetResponse>
Retrieve a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersID
Parameters
- request: GetScrapersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ScraperTargetResponse>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:156

getScrapersIDLabels

getScrapersIDLabels(
request: GetScrapersIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelsResponse>
List all labels for a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersIDLabels
Parameters
- request: GetScrapersIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelsResponse>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:211

getScrapersIDMembers

getScrapersIDMembers(
request: GetScrapersIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMembers>
List all users with member privileges for a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersIDMembers
Parameters
- request: GetScrapersIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMembers>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:266

getScrapersIDOwners

getScrapersIDOwners(
request: GetScrapersIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwners>
List all owners of a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersIDOwners
Parameters
- request: GetScrapersIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwners>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:321

patchScrapersID

patchScrapersID(
request: PatchScrapersIDRequest,
requestOptions?: RequestOptions,
): Promise<ScraperTargetResponse>
Update a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchScrapersID
Parameters
- request: PatchScrapersIDRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ScraperTargetResponse>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:174

postScrapers

postScrapers(
request: PostScrapersRequest,
requestOptions?: RequestOptions,
): Promise<ScraperTargetResponse>
Create a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapers
Parameters
- request: PostScrapersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ScraperTargetResponse>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:137

postScrapersIDLabels

postScrapersIDLabels(
request: PostScrapersIDLabelsRequest,
requestOptions?: RequestOptions,
): Promise<LabelResponse>
Add a label to a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapersIDLabels
Parameters
- request: PostScrapersIDLabelsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<LabelResponse>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:229

postScrapersIDMembers

postScrapersIDMembers(
request: PostScrapersIDMembersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceMember>
Add a member to a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapersIDMembers
Parameters
- request: PostScrapersIDMembersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceMember>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:284

postScrapersIDOwners

postScrapersIDOwners(
request: PostScrapersIDOwnersRequest,
requestOptions?: RequestOptions,
): Promise<ResourceOwner>
Add an owner to a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapersIDOwners
Parameters
- request: PostScrapersIDOwnersRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ResourceOwner>
promise of response
- Defined in apis/src/generated/ScrapersAPI.ts:339

Class ScrapersAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ScrapersAPI

Methods

deleteScrapersID

Parameters

Returns Promise<void>

deleteScrapersIDLabelsID

Parameters

Returns Promise<void>

deleteScrapersIDMembersID

Parameters

Returns Promise<void>

deleteScrapersIDOwnersID

Parameters

Returns Promise<void>

getScrapers

Parameters

Returns Promise<ScraperTargetResponses>

getScrapersID

Parameters

Returns Promise<ScraperTargetResponse>

getScrapersIDLabels

Parameters

Returns Promise<LabelsResponse>

getScrapersIDMembers

Parameters

Returns Promise<ResourceMembers>

getScrapersIDOwners

Parameters

Returns Promise<ResourceOwners>

patchScrapersID

Parameters

Returns Promise<ScraperTargetResponse>

postScrapers

Parameters

Returns Promise<ScraperTargetResponse>

postScrapersIDLabels

Parameters

Returns Promise<LabelResponse>

postScrapersIDMembers

Parameters

Returns Promise<ResourceMember>

postScrapersIDOwners

Parameters

Returns Promise<ResourceOwner>

Settings

On This Page