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

InfluxDB Telegrafs API

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

InfluxDB Telegrafs API is one of 40 APIs that InfluxDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Telegrafs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, authentication docs, and a getting-started guide.

This API exposes 14 operations across 8 paths, and defines 19 schemas. It is described by OpenAPI 3.0.0.

Requests are made against the base URL https://cloud2.influxdata.com/api/v2.

14 operations 8 paths 19 schemas 4 DELETE5 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
Base URL
https://cloud2.influxdata.com/api/v2
Authentication
HTTP Basic, API Key
Resource Areas
1

Authentication & Security 2

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

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

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

Schemas 19

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

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

influxdb-telegrafs-api-openapi.yml Raw ↑

Other APIs InfluxDB publishes across the network.

InfluxDB Authorizations (API tokens) API
InfluxDB Bucket Schemas API
InfluxDB Buckets API
InfluxDB Cells API
InfluxDB Checks API
InfluxDB Config API
InfluxDB Dashboards API
InfluxDB Data I/O endpoints API
InfluxDB DBRPs API
InfluxDB Delete API
InfluxDB Invokable Scripts API
InfluxDB Labels API