Home > @influxdata/influxdb-client-apis > ScrapersAPI

ScrapersAPI class

Scrapers API

Signature:

declare class ScrapersAPI 

Constructors

Constructor	Modifiers	Description
(constructor)(influxDB)		Creates ScrapersAPI

Methods

Method	Modifiers	Description
deleteScrapersID(request, requestOptions)		Delete a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersID
deleteScrapersIDLabelsID(request, requestOptions)		Delete a label from a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersIDLabelsID
deleteScrapersIDMembersID(request, requestOptions)		Remove a member from a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersIDMembersID
deleteScrapersIDOwnersID(request, requestOptions)		Remove an owner from a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/DeleteScrapersIDOwnersID
getScrapers(request, requestOptions)		List all scraper targets. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapers
getScrapersID(request, requestOptions)		Retrieve a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersID
getScrapersIDLabels(request, requestOptions)		List all labels for a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersIDLabels
getScrapersIDMembers(request, requestOptions)		List all users with member privileges for a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersIDMembers
getScrapersIDOwners(request, requestOptions)		List all owners of a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetScrapersIDOwners
patchScrapersID(request, requestOptions)		Update a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PatchScrapersID
postScrapers(request, requestOptions)		Create a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapers
postScrapersIDLabels(request, requestOptions)		Add a label to a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapersIDLabels
postScrapersIDMembers(request, requestOptions)		Add a member to a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapersIDMembers
postScrapersIDOwners(request, requestOptions)		Add an owner to a scraper target. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostScrapersIDOwners