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 Telegrafs API

The Telegrafs API from InfluxData — 8 operation(s) for telegrafs.

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

Tagged areas include Telegrafs. 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 18 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 18 schemas 4 DELETE5 GET4 POST1 PUT

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 Telegrafs 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, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Telegrafs 14
GET
/telegrafs
List all Telegraf configurations
GetTelegrafs 2 params → 200default
POST
/telegrafs
Create a Telegraf configuration
PostTelegrafs 1 param body → 201default
GET
/telegrafs/{telegrafID}
Retrieve a Telegraf configuration
GetTelegrafsID 3 params → 200default
PUT
/telegrafs/{telegrafID}
Update a Telegraf configuration
PutTelegrafsID 2 params body → 200default
DELETE
/telegrafs/{telegrafID}
Delete a Telegraf configuration
DeleteTelegrafsID 2 params → 204default
GET
/telegrafs/{telegrafID}/labels
List all labels for a Telegraf config
GetTelegrafsIDLabels 2 params → 200default
POST
/telegrafs/{telegrafID}/labels
Add a label to a Telegraf config
PostTelegrafsIDLabels 2 params body → 201default
DELETE
/telegrafs/{telegrafID}/labels/{labelID}
Delete a label from a Telegraf config
DeleteTelegrafsIDLabelsID 3 params → 204404default
GET
/telegrafs/{telegrafID}/members
List all users with member privileges for a Telegraf config
GetTelegrafsIDMembers 2 params → 200default
POST
/telegrafs/{telegrafID}/members
Add a member to a Telegraf config
PostTelegrafsIDMembers 2 params body → 201default
DELETE
/telegrafs/{telegrafID}/members/{userID}
Remove a member from a Telegraf config
DeleteTelegrafsIDMembersID 3 params → 204default
GET
/telegrafs/{telegrafID}/owners
List all owners of a Telegraf configuration
GetTelegrafsIDOwners 2 params → 200default
POST
/telegrafs/{telegrafID}/owners
Add an owner to a Telegraf configuration
PostTelegrafsIDOwners 2 params body → 201default
DELETE
/telegrafs/{telegrafID}/owners/{userID}
Remove an owner from a Telegraf config
DeleteTelegrafsIDOwnersID 3 params → 204default

Schemas 18

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdata-telegrafs-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