Skip to content

Influx OSS API Service API

by influxdata.com

HTTP BasicHTTPSIoT
Open documentation ↗

Overview

# Authentication <!-- ReDoc-Inject: <security-definitions> -->

Influx OSS API Service is an iot API from influxdata.com. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 197 endpoints.

At a glance

Authentication
HTTP Basic
HTTPS
Yes
CORS
Unknown
Category
IoT
Version
2.0.0
Endpoints
197
Spec updated
2021-07-05

Endpoints

MethodPathWhat it does
GET/List all top level routes
GET/authorizationsList all authorizations
POST/authorizationsCreate an authorization
GET/authorizations/{authID}Retrieve an authorization
PATCH/authorizations/{authID}Update an authorization to be active or inactive
DELETE/authorizations/{authID}Delete an authorization
GET/bucketsList all buckets
POST/bucketsCreate a bucket
GET/buckets/{bucketID}Retrieve a bucket
PATCH/buckets/{bucketID}Update a bucket
DELETE/buckets/{bucketID}Delete a bucket
GET/buckets/{bucketID}/labelsList all labels for a bucket
POST/buckets/{bucketID}/labelsAdd a label to a bucket
DELETE/buckets/{bucketID}/labels/{labelID}Delete a label from a bucket
GET/buckets/{bucketID}/membersList all users with member privileges for a bucket
POST/buckets/{bucketID}/membersAdd a member to a bucket
DELETE/buckets/{bucketID}/members/{userID}Remove a member from a bucket
GET/buckets/{bucketID}/ownersList all owners of a bucket
POST/buckets/{bucketID}/ownersAdd an owner to a bucket
DELETE/buckets/{bucketID}/owners/{userID}Remove an owner from a bucket
GET/checksList all checks
POST/checksAdd new check
GET/checks/{checkID}Retrieve a check
PUT/checks/{checkID}Update a check
PATCH/checks/{checkID}Update a check
DELETE/checks/{checkID}Delete a check
GET/checks/{checkID}/labelsList all labels for a check
POST/checks/{checkID}/labelsAdd a label to a check
DELETE/checks/{checkID}/labels/{labelID}Delete label from a check
GET/checks/{checkID}/queryRetrieve a check query
GET/dashboardsList all dashboards
POST/dashboardsCreate a dashboard
GET/dashboards/{dashboardID}Retrieve a Dashboard
PATCH/dashboards/{dashboardID}Update a dashboard
DELETE/dashboards/{dashboardID}Delete a dashboard
POST/dashboards/{dashboardID}/cellsCreate a dashboard cell
PUT/dashboards/{dashboardID}/cellsReplace cells in a dashboard
PATCH/dashboards/{dashboardID}/cells/{cellID}Update the non-positional information related to a cell
DELETE/dashboards/{dashboardID}/cells/{cellID}Delete a dashboard cell
GET/dashboards/{dashboardID}/cells/{cellID}/viewRetrieve the view for a cell
PATCH/dashboards/{dashboardID}/cells/{cellID}/viewUpdate the view for a cell
GET/dashboards/{dashboardID}/labelsList all labels for a dashboard
POST/dashboards/{dashboardID}/labelsAdd a label to a dashboard
DELETE/dashboards/{dashboardID}/labels/{labelID}Delete a label from a dashboard
GET/dashboards/{dashboardID}/membersList all dashboard members
POST/dashboards/{dashboardID}/membersAdd a member to a dashboard
DELETE/dashboards/{dashboardID}/members/{userID}Remove a member from a dashboard
GET/dashboards/{dashboardID}/ownersList all dashboard owners
POST/dashboards/{dashboardID}/ownersAdd an owner to a dashboard
DELETE/dashboards/{dashboardID}/owners/{userID}Remove an owner from a dashboard
GET/dbrpsList all database retention policy mappings
POST/dbrpsAdd a database retention policy mapping
GET/dbrps/{dbrpID}Retrieve a database retention policy mapping
PATCH/dbrps/{dbrpID}Update a database retention policy mapping
DELETE/dbrps/{dbrpID}Delete a database retention policy
POST/deleteDelete time series data from InfluxDB
GET/documents/templatesList all templates
POST/documents/templatesCreate a template
GET/documents/templates/{templateID}Retrieve a template
PUT/documents/templates/{templateID}Update a template
DELETE/documents/templates/{templateID}Delete a template
GET/documents/templates/{templateID}/labelsList all labels for a template
POST/documents/templates/{templateID}/labelsAdd a label to a template
DELETE/documents/templates/{templateID}/labels/{labelID}Delete a label from a template
GET/flagsReturn the feature flags for the currently authenticated user
GET/healthGet the health of an instance
GET/labelsList all labels
POST/labelsCreate a label
GET/labels/{labelID}Retrieve a label
PATCH/labels/{labelID}Update a label
DELETE/labels/{labelID}Delete a label
GET/meRetrieve the currently authenticated user
PUT/me/passwordUpdate a password
GET/notificationEndpointsList all notification endpoints
POST/notificationEndpointsAdd a notification endpoint
GET/notificationEndpoints/{endpointID}Retrieve a notification endpoint
PUT/notificationEndpoints/{endpointID}Update a notification endpoint
PATCH/notificationEndpoints/{endpointID}Update a notification endpoint
DELETE/notificationEndpoints/{endpointID}Delete a notification endpoint
GET/notificationEndpoints/{endpointID}/labelsList all labels for a notification endpoint
POST/notificationEndpoints/{endpointID}/labelsAdd a label to a notification endpoint
DELETE/notificationEndpoints/{endpointID}/labels/{labelID}Delete a label from a notification endpoint
GET/notificationRulesList all notification rules
POST/notificationRulesAdd a notification rule
GET/notificationRules/{ruleID}Retrieve a notification rule
PUT/notificationRules/{ruleID}Update a notification rule
PATCH/notificationRules/{ruleID}Update a notification rule
DELETE/notificationRules/{ruleID}Delete a notification rule
GET/notificationRules/{ruleID}/labelsList all labels for a notification rule
POST/notificationRules/{ruleID}/labelsAdd a label to a notification rule
DELETE/notificationRules/{ruleID}/labels/{labelID}Delete label from a notification rule
GET/notificationRules/{ruleID}/queryRetrieve a notification rule query
GET/orgsList all organizations
POST/orgsCreate an organization
GET/orgs/{orgID}Retrieve an organization
PATCH/orgs/{orgID}Update an organization
DELETE/orgs/{orgID}Delete an organization
GET/orgs/{orgID}/membersList all members of an organization
POST/orgs/{orgID}/membersAdd a member to an organization
DELETE/orgs/{orgID}/members/{userID}Remove a member from an organization

Showing the first 100 of 197 endpoints; the full list is in the documentation.

Questions

Does the Influx OSS API Service API need an API key?

Yes. The Influx OSS API Service API uses HTTP Basic authentication; the documentation explains how to get credentials.

Does the Influx OSS API Service API support HTTPS?

Yes, the Influx OSS API Service API is served over HTTPS.

How many endpoints does the Influx OSS API Service API have?

Its OpenAPI description lists 197 endpoints in version 2.0.0. The first 100 are shown on this page.

What are alternatives to the Influx OSS API Service API?

Other IoT APIs include Brain Web API, Adafruit IO REST API, Netatmo, ClearBlade API, Hardware Sentry TrueSight Presentation Server REST API.

Compare alternatives →

Brain Web API

IoT

This document describes the [Intellifi Brain](https://intellifi.zendesk.com/hc/en-us/categories/360000685454) Web API specification using the [OpenAPI specification](https://github.com/OAI/OpenAPI-Specification). The Brain Web API is a RESTful API that allows you to interact with the [Intellifi devices](https://intellifi.zendesk.com/hc/en-us/categories/360000685434) and services in a powerful and simple way. Our end-to-end solution allows you to localize your items/assets based on technologies such as RFID and Bluetooth. # Try it out! The API can be tried out and tested using the ['api-doc/tryitout' endpoint on this site](./tryitout/). This UI allows anyone to visualize and interact with the API’s resources without having any of the implementation logic in place. It’s automatically generated from this Specification, with the visual documentation making it easy for back end implementation and client side consumption. # Authentication Applications are required to provide some form of authentication to the API for every secured endpoint. The Brain offers two forms of authentication. - API key (Via an HTTP request header or URL parameter) - Session cookie <!-- ReDoc-Inject: <security-definitions> --> # See also - About Intellifi and what we do: [intellifi.nl](https://intellifi.nl) - Technical and background information: [intellifi.zendesk.com](https://intellifi.zendesk.com)

API key77 endpoints

Adafruit IO REST API

IoT

### The Internet of Things for Everyone The Adafruit IO HTTP API provides access to your Adafruit IO data from any programming language or hardware environment that can speak HTTP. The easiest way to get started is with [an Adafruit IO learn guide](https://learn.adafruit.com/series/adafruit-io-basics) and [a simple Internet of Things capable device like the Feather Huzzah](https://www.adafruit.com/product/2821). This API documentation is hosted on GitHub Pages and is available at [https://github.com/adafruit/io-api](https://github.com/adafruit/io-api). For questions or comments visit the [Adafruit IO Forums](https://forums.adafruit.com/viewforum.php?f=56) or the [adafruit-io channel on the Adafruit Discord server](https://discord.gg/adafruit). #### Authentication Authentication for every API request happens through the `X-AIO-Key` header or query parameter and your IO API key. A simple cURL request to get all available feeds for a user with the username "io_username" and the key "io_key_12345" could look like this: $ curl -H "X-AIO-Key: io_key_12345" https://io.adafruit.com/api/v2/io_username/feeds Or like this: $ curl "https://io.adafruit.com/api/v2/io_username/feeds?X-AIO-Key=io_key_12345 Using the node.js [request](https://github.com/request/request) library, IO HTTP requests are as easy as: ```js var request = require('request'); var options = { url: 'https://io.adafruit.com/api/v2/io_username/feeds', headers: { 'X-AIO-Key': 'io_key_12345', 'Content-Type': 'application/json' } }; function callback(error, response, body) { if (!error && response.statusCode == 200) { var feeds = JSON.parse(body); console.log(feeds.length + " FEEDS AVAILABLE"); feeds.forEach(function (feed) { console.log(feed.name, feed.key); }) } } request(options, callback); ``` Using the ESP8266 Arduino HTTPClient library, an HTTPS GET request would look like this (replacing `---` with your own values in the appropriate locations): ```arduino /// based on /// https://github.com/esp8266/Arduino/blob/master/libraries/ESP8266HTTPClient/examples/Authorization/Authorization.ino #include <Arduino.h> #include <ESP8266WiFi.h> #include <ESP8266WiFiMulti.h> #include <ESP8266HTTPClient.h> ESP8266WiFiMulti WiFiMulti; const char* ssid = "---"; const char* password = "---"; const char* host = "io.adafruit.com"; const char* io_key = "---"; const char* path_with_username = "/api/v2/---/dashboards"; // Use web browser to view and copy // SHA1 fingerprint of the certificate const char* fingerprint = "77 00 54 2D DA E7 D8 03 27 31 23 99 EB 27 DB CB A5 4C 57 18"; void setup() { Serial.begin(115200); for(uint8_t t = 4; t > 0; t--) { Serial.printf("[SETUP] WAIT %d...\n", t); Serial.flush(); delay(1000); } WiFi.mode(WIFI_STA); WiFiMulti.addAP(ssid, password); // wait for WiFi connection while(WiFiMulti.run() != WL_CONNECTED) { Serial.print('.'); delay(1000); } Serial.println("[WIFI] connected!"); HTTPClient http; // start request with URL and TLS cert fingerprint for verification http.begin("https://" + String(host) + String(path_with_username), fingerprint); // IO API authentication http.addHeader("X-AIO-Key", io_key); // start connection and send HTTP header int httpCode = http.GET(); // httpCode will be negative on error if(httpCode > 0) { // HTTP header has been send and Server response header has been handled Serial.printf("[HTTP] GET response: %d\n", httpCode); // HTTP 200 OK if(httpCode == HTTP_CODE_OK) { String payload = http.getString(); Serial.println(payload); } http.end(); } } void loop() {} ``` #### Client Libraries We have client libraries to help you get started with your project: [Python](https://github.com/adafruit/io-client-python), [Ruby](https://github.com/adafruit/io-client-ruby), [Arduino C++](https://github.com/adafruit/Adafruit_IO_Arduino), [Javascript](https://github.com/adafruit/adafruit-io-node), and [Go](https://github.com/adafruit/io-client-go) are available. They're all open source, so if they don't already do what you want, you can fork and add any

API key71 endpoints

Netatmo

IoT

<h3>Welcome to the Netatmo swagger on-line documentation !</h3> This site is a complement to the official <a href="https://dev.netatmo.com/">Netatmo developper documentation</a> using swagger to bring interactivity and easy testing of requests with the "try it" button (authenticate with the authorization code OAuth2 flow by clicking the authenticate button in the methods). You can find the source code for this site can be found in the project <a href="https://github.com/cbornet/netatmo-swagger-ui">netatmo-swagger-ui</a>. You can also use the online <a href="./swagger.json">swagger declaration</a> file to generate code or static documentation (see <a href="https://github.com/cbornet/netatmo-swagger-api">netatmo-swagger-api</a>).

OAuth22 endpoints

ClearBlade API

IoT

A friendly little API to help you interact with the ClearBlade platform.

No auth220 endpoints

Hardware Sentry TrueSight Presentation Server REST API

IoT

Hardware Sentry TrueSight Presentation Server REST API

API key23 endpoints

Quick start - Telematics SDK

IoT

# Introduction We have prepared a set of APIs for quick start to integrate telematics SDK that powers mobile telematics inside 3rd party mobile applications. * [CONTACT US](https://telematicssdk.com) * [SANDBOX](https://userdatahub.com) * [DEV.PORTAL](https://docs.telematicssdk.com) * [DEMO APP](https://raxeltelematics.com/telematics-app) # Overview Datamotion provides telematics infrastructure for mobile applications. Telematics SDK turns any smartphone into telematics data gathering device to collect Location, driving and behavior data. API services unlocks power of your mobile application There are 3 groups of methods: * 1 - user management * 2 - statistics for mobile app * 3 - statistics for back-end(s) in certain cases you will need SNS or any other notification services. read more [here](https://docs.telematicssdk.com/platform-features/sns) # Possible architecture There are three common schemes that are used by our clients. These schemes can be combined * Collect, Process, Store (required: 1&2) * Collect, Process (required: 1& sns) * Collect (required 1&sns) ## Collect, Process, Store ![Collect, Process, Store](https://website-cliparts-datamotion.s3.us-east-2.amazonaws.com/Dev.portal/Architecture+-+Collection%2C+processing%2C+storage) ## Collect, Process ![Collect, Process](https://website-cliparts-datamotion.s3.us-east-2.amazonaws.com/Dev.portal/Architecture+-+Collection+and+processing) ## Collect ![Collect](https://website-cliparts-datamotion.s3.us-east-2.amazonaws.com/Dev.portal/Architecture+-+Collection+only) *** ![Telematic sdk](https://website-cliparts-datamotion.s3.us-east-2.amazonaws.com/Github/transportation_small.png) # Common use-cases: * Safe and efficient driving * Usage-based insurance * Safe driving assessment * Driver assessment * Trip log * Geo-analysis * Accident monitoring * Driving engagements * Location based services * Realtime Tracking and beyond # How to start * Register a [SANDBOX ACCOUNT](https://userdatahub.com) * Get [CREDENTIALS](https://docs.userdatahub.com/sandbox/credentials) * Follow the guide from [DEVELOPER POERTAL](https://docs.telematicssdk.com) # Authentication To create a user on datamotion platform, you require to use InstanceID and InstanceKEY. You can get it in Datahub -> management -> user-service credentials Once you create a user, you will get Device token, JWT token and refresh token. then, you will use it for APIs

No auth9 endpoints

Listed from APIs.guru (CC0).