Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

InfluxData Scraper Targets API

The Scraper Targets API from InfluxData — 8 operation(s) for scraper targets.

InfluxData Scraper Targets API is one of 45 APIs that InfluxData publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Scraper Targets. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and a getting-started guide.

This API exposes 14 operations across 8 paths, and defines 17 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

Requests are made against a single base URL, /api/v2.

14 operations 8 paths 17 schemas 4 DELETE5 GET1 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.1
Base URL
https://us-east-1-1.aws.cloud2.influxdata.com/api/v2
Authentication
API Key, HTTP Basic
License
Resource Areas
1

Authentication & Security 2

InfluxData Scraper Targets API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (TokenAuthentication). It accepts HTTP basic authentication (BasicAuthentication). By default, every request must be authenticated.

  • TokenAuthentication — Use the [Token authentication](section/Authentication/TokenAuthentication) scheme to authenticate to the InfluxDB API. In your API requests, send an Authorizat…
  • BasicAuthentication — Basic authentication scheme Use the HTTP Basic authentication scheme for InfluxDB /api/v2 API operations that support it: Syntax Authorization: Basic BASE64ENC…

Paths & Operations 14

Across 8 paths, the API surfaces 14 operations — 4 DELETE, 5 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Scraper Targets 14
GET
/scrapers
List all scraper targets
GetScrapers 5 params → 200
POST
/scrapers
Create a scraper target
PostScrapers 1 param body → 201default
GET
/scrapers/{scraperTargetID}
Retrieve a scraper target
GetScrapersID 2 params → 200default
DELETE
/scrapers/{scraperTargetID}
Delete a scraper target
DeleteScrapersID 2 params → 204default
PATCH
/scrapers/{scraperTargetID}
Update a scraper target
PatchScrapersID 2 params body → 200default
GET
/scrapers/{scraperTargetID}/labels
List all labels for a scraper target
GetScrapersIDLabels 2 params → 200default
POST
/scrapers/{scraperTargetID}/labels
Add a label to a scraper target
PostScrapersIDLabels 2 params body → 201default
DELETE
/scrapers/{scraperTargetID}/labels/{labelID}
Delete a label from a scraper target
DeleteScrapersIDLabelsID 3 params → 204404default
GET
/scrapers/{scraperTargetID}/members
List all users with member privileges for a scraper target
GetScrapersIDMembers 2 params → 200default
POST
/scrapers/{scraperTargetID}/members
Add a member to a scraper target
PostScrapersIDMembers 2 params body → 201default
DELETE
/scrapers/{scraperTargetID}/members/{userID}
Remove a member from a scraper target
DeleteScrapersIDMembersID 3 params → 204default
GET
/scrapers/{scraperTargetID}/owners
List all owners of a scraper target
GetScrapersIDOwners 2 params → 200default
POST
/scrapers/{scraperTargetID}/owners
Add an owner to a scraper target
PostScrapersIDOwners 2 params body → 201default
DELETE
/scrapers/{scraperTargetID}/owners/{userID}
Remove an owner from a scraper target
DeleteScrapersIDOwnersID 3 params → 204default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are ScraperTargetRequest (6 properties), UserResponse (4 properties), Error (4 properties), Label (4 properties). Each schema is shown below with its type and property counts.

ResourceMember
LabelMapping
object
A label mapping contains a label ID to attach to a resource.
1 property 1 required
ScraperTargetRequest
object
6 properties
ScraperTargetResponses
object
1 property
Label
object
4 properties
Labels
array
UserResponse
object
4 properties 1 required
Links
object
URI pointers for additional paged results.
3 properties 1 required
ResourceOwner
LabelsResponse
object
2 properties
LabelResponse
object
2 properties
AddResourceMemberRequestBody
object
2 properties 1 required
Link
string
URI of resource.
ResourceOwners
object
2 properties
ScraperTargetResponse
object
ResourceMembers
object
2 properties
Error
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-scraper-targets-api-openapi.yml Raw ↑

Other APIs InfluxData publishes across the network.

InfluxData Authorizations (API tokens) API
InfluxData Backup API
InfluxData Bucket Schemas API
InfluxData Buckets API
InfluxData Cells API
InfluxData Checks API
InfluxData Config API
InfluxData Dashboards API
InfluxData Data I/O endpoints API
InfluxData DBRPs API
InfluxData Debug API
InfluxData Delete API