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

The Sources API from InfluxData — 4 operation(s) for sources.

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

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

This API exposes 7 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.0, at version 2.0.1.

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

7 operations 4 paths 13 schemas 1 DELETE4 GET1 PATCH1 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 Sources 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 7

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

Sources 7
POST
/sources
Create a source
PostSources 1 param body → 201default
GET
/sources
List all sources
GetSources 2 params → 200default
DELETE
/sources/{sourceID}
Delete a source
DeleteSourcesID 2 params → 204404default
PATCH
/sources/{sourceID}
Update a Source
PatchSourcesID 2 params body → 200404default
GET
/sources/{sourceID}
Retrieve a source
GetSourcesID 2 params → 200404default
GET
/sources/{sourceID}/health
Get the health of a source
GetSourcesIDHealth 2 params → 200503default
GET
/sources/{sourceID}/buckets
Get buckets in a source
GetSourcesIDBuckets 3 params → 200404default

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Source (16 properties), Bucket (12 properties), HealthCheck (6 properties), Label (4 properties). Each schema is shown below with its type and property counts.

HealthCheck
object
6 properties 2 required
RetentionRule
object
3 properties 1 required
SchemaType
string
Label
object
4 properties
Labels
array
RetentionRules
array
Retention rules to expire or retain data. The InfluxDB /api/v2 API uses RetentionRules to configure the [retention period](https://docs.influxdata.com/influxdb…
Source
object
16 properties
Sources
object
2 properties
Buckets
object
2 properties
Bucket
object
12 properties 2 required
Link
string
URI of resource.
Error
object
4 properties 1 required
Links
object
URI pointers for additional paged results.
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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