InfluxDB offers a common API across the entire platform. Discover what that means and how you can use the API to build solutions that deliver real value for developers.
3. InfluxDB offers a common API across the entire platform. Discover what
that means and how you can use the API to build solutions that deliver
real value for developers.
Vinay Kumar
Senior Product Manager, InfluxData
Platform Product Manager at InfluxData with a Cloud Infrastructure
and Networking background working at companies like MuleSoft,
Salesforce and Ericsson.
InfluxDB API Overview
6. Value creation tool for developers
App developers create value Story of data
Time
Data
7. Composable Applications → APIs
● Modern Applications are built using
a set of built for purpose tools
● APIs are the language of the
composable Application
● Highly performant Time Series DB to
fuel your Application = InfluxDB!
/write
/query
/buckets
/authorizations
/tasks
/scripts
/orgs
……..
InfluxData
API
10. Pillars of the API
Data
Input
Query
Automation
Platform
Management
Analyze
Transform
Alert
Downsample
Trigger
11. Data Ingest - /write Endpoint
Multiple ways to ingest data into the
platform - all using /write endpoint:
● Write API
● Influx CLI
● Client libraries
● Telegraf
● Bulk import CSV
● Load data in UI
12. Process data - Query and transform
Query using /query endpoint:
● Data Explorer & Dashboards
● InfluxDB API
● InfluxDB CLI
● Client libraries
Query with
● Flux
● InfluxQL
13. ● Queries results via the API are in
annotated CSV format
● Set Accept-Encoding header to
gzip, to compress query response
● Client libraries wrap the Query API
in the language of choice
● Ability to return data is a variety of
data formats:
○ CSV
○ Raw Data
○ Table
○ Stream
○ Pandas DataFrame
Querying using client libraries
Querying API endpoint directly
14. Automation - Tasks and Alerting
Tasks and scripts are Powerful
Automation Tools:
● Queries run on the platform without
the need for any additional hardware,
OS provisioning on customer
infrastructure
● Run Alerting logic that can trigger
notifications on Slack, Pagerduty etc.
● Power of Flux - Query buckets,
external data, join data, trigger
actions, save to buckets, alert /tasks
Augmented
Data
Relational Data
Alerts
Trigger Actions -
HTTP
Raw
Data
15. Script
Automation - Invokable Scripts
● API Invokable Scripts can be triggered to run Flux logic from
applications or work flow tools.
● Tasks can Invoke Scripts - improving Tasks management at scale.
/scripts
Tasks
Script
Input Parameters
Output
Tasks
Tasks
Tasks
Tasks
Tasks
Tasks
Create N Tasks passing
parameters to invoke the Script
/api/v2/scripts/{name}/invoke
Modify Script to update Task logic
Create a reusable
and invokable Flux
asset
Driving Flux logic re-use on the platform
/api/v2/scripts/{name}/invoke
Invoke the Script from your
Application/workflow logic
16. Platform Management
Manage key account resources within
InfluxDB:
● /orgs - CRUD operations on
Organizations
● /buckets - CRUD operations on
buckets
● /authorizations - CRUD operations
for tokens
● /orgs/{orgID}/secrets - secrets store
Required Parameters for /buckets:
● Bucket - bucket to write to
● OrgID - InfluxDB OrgID
● Retention Rules - time to live
● Token - InfluxDB API Token