Influxdata

Influx OSS API Service

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

IoT & devices#openapi#iot

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Authentication

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

Endpoints 197

Routes

  • GETList all top level routes/

Authorizations

  • GETList all authorizations/authorizations?userID=string&user=string&orgID=string&org=string
  • POSTCreate an authorization/authorizations
  • GETRetrieve an authorization/authorizations/:authID
  • DELETEDelete an authorization/authorizations/:authID
  • PATCHUpdate an authorization to be active or inactive/authorizations/:authID

Buckets

  • GETList all buckets/buckets?offset=0&limit=20&after=string&org=string&orgID=string&name=string&id=string
  • POSTCreate a bucket/buckets
  • GETRetrieve a bucket/buckets/:bucketID
  • DELETEDelete a bucket/buckets/:bucketID
  • PATCHUpdate a bucket/buckets/:bucketID
  • GETList all labels for a bucket/buckets/:bucketID/labels
  • POSTAdd a label to a bucket/buckets/:bucketID/labels
  • DELETEDelete a label from a bucket/buckets/:bucketID/labels/:labelID
  • GETList all users with member privileges for a bucket/buckets/:bucketID/members
  • POSTAdd a member to a bucket/buckets/:bucketID/members
  • DELETERemove a member from a bucket/buckets/:bucketID/members/:userID
  • GETList all owners of a bucket/buckets/:bucketID/owners
  • POSTAdd an owner to a bucket/buckets/:bucketID/owners
  • DELETERemove an owner from a bucket/buckets/:bucketID/owners/:userID

Checks

  • GETList all checks/checks?offset=0&limit=20&orgID=string
  • POSTAdd new check/checks
  • GETRetrieve a check/checks/:checkID
  • PUTUpdate a check/checks/:checkID
  • DELETEDelete a check/checks/:checkID
  • PATCHUpdate a check/checks/:checkID
  • GETList all labels for a check/checks/:checkID/labels
  • POSTAdd a label to a check/checks/:checkID/labels
  • DELETEDelete label from a check/checks/:checkID/labels/:labelID
  • GETRetrieve a check query/checks/:checkID/query

Dashboards

  • GETList all dashboards/dashboards?offset=0&limit=20&descending=false&owner=string&sortBy=ID&id=string&orgID=string&org=string
  • POSTCreate a dashboard/dashboards
  • GETRetrieve a Dashboard/dashboards/:dashboardID?include=properties
  • DELETEDelete a dashboard/dashboards/:dashboardID
  • PATCHUpdate a dashboard/dashboards/:dashboardID
  • GETList all labels for a dashboard/dashboards/:dashboardID/labels
  • POSTAdd a label to a dashboard/dashboards/:dashboardID/labels
  • DELETEDelete a label from a dashboard/dashboards/:dashboardID/labels/:labelID
  • GETList all dashboard members/dashboards/:dashboardID/members
  • POSTAdd a member to a dashboard/dashboards/:dashboardID/members
  • DELETERemove a member from a dashboard/dashboards/:dashboardID/members/:userID
  • GETList all dashboard owners/dashboards/:dashboardID/owners
  • POSTAdd an owner to a dashboard/dashboards/:dashboardID/owners
  • DELETERemove an owner from a dashboard/dashboards/:dashboardID/owners/:userID

Cells

  • PUTReplace cells in a dashboard/dashboards/:dashboardID/cellsReplaces all cells in a dashboard. This is used primarily to update the positional information of all cells.
  • POSTCreate a dashboard cell/dashboards/:dashboardID/cells
  • DELETEDelete a dashboard cell/dashboards/:dashboardID/cells/:cellID
  • PATCHUpdate the non-positional information related to a cell/dashboards/:dashboardID/cells/:cellIDUpdates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.
  • GETRetrieve the view for a cell/dashboards/:dashboardID/cells/:cellID/view
  • PATCHUpdate the view for a cell/dashboards/:dashboardID/cells/:cellID/view

DBRPs

  • GETList all database retention policy mappings/dbrps?orgID=string&id=string&bucketID=string&default=true&db=string&rp=string
  • POSTAdd a database retention policy mapping/dbrps
  • GETRetrieve a database retention policy mapping/dbrps/:dbrpID?orgID=string
  • DELETEDelete a database retention policy/dbrps/:dbrpID?orgID=string
  • PATCHUpdate a database retention policy mapping/dbrps/:dbrpID?orgID=string

Delete

  • POSTDelete time series data from InfluxDB/delete?org=string&bucket=string&orgID=string&bucketID=string

Templates

  • GETList all templates/documents/templates?org=string&orgID=string
  • POSTCreate a template/documents/templates
  • GETRetrieve a template/documents/templates/:templateID
  • PUTUpdate a template/documents/templates/:templateID
  • DELETEDelete a template/documents/templates/:templateID
  • GETList all labels for a template/documents/templates/:templateID/labels
  • POSTAdd a label to a template/documents/templates/:templateID/labels
  • DELETEDelete a label from a template/documents/templates/:templateID/labels/:labelID

Users

  • GETReturn the feature flags for the currently authenticated user/flags
  • GETRetrieve the currently authenticated user/me
  • PUTUpdate a password/me/password
  • GETList all users/users?offset=0&limit=20&after=string&name=string&id=string
  • POSTCreate a user/users
  • GETRetrieve a user/users/:userID
  • DELETEDelete a user/users/:userID
  • PATCHUpdate a user/users/:userID
  • POSTUpdate a password/users/:userID/password

Health

  • GETGet the health of an instance/health

Labels

  • GETList all labels/labels?orgID=string
  • POSTCreate a label/labels
  • GETRetrieve a label/labels/:labelID
  • DELETEDelete a label/labels/:labelID
  • PATCHUpdate a label/labels/:labelID

NotificationEndpoints

  • GETList all notification endpoints/notificationEndpoints?offset=0&limit=20&orgID=string
  • POSTAdd a notification endpoint/notificationEndpoints
  • GETRetrieve a notification endpoint/notificationEndpoints/:endpointID
  • PUTUpdate a notification endpoint/notificationEndpoints/:endpointID
  • DELETEDelete a notification endpoint/notificationEndpoints/:endpointID
  • PATCHUpdate a notification endpoint/notificationEndpoints/:endpointID
  • GETList all labels for a notification endpoint/notificationEndpoints/:endpointID/labels
  • POSTAdd a label to a notification endpoint/notificationEndpoints/:endpointID/labels
  • DELETEDelete a label from a notification endpoint/notificationEndpoints/:endpointID/labels/:labelID

NotificationRules

  • GETList all notification rules/notificationRules?offset=0&limit=20&orgID=string&checkID=string&tag=env:prod
  • POSTAdd a notification rule/notificationRules
  • GETRetrieve a notification rule/notificationRules/:ruleID
  • PUTUpdate a notification rule/notificationRules/:ruleID
  • DELETEDelete a notification rule/notificationRules/:ruleID
  • PATCHUpdate a notification rule/notificationRules/:ruleID
  • GETList all labels for a notification rule/notificationRules/:ruleID/labels
  • POSTAdd a label to a notification rule/notificationRules/:ruleID/labels
  • DELETEDelete label from a notification rule/notificationRules/:ruleID/labels/:labelID

Rules

  • GETRetrieve a notification rule query/notificationRules/:ruleID/query

Organizations

  • GETList all organizations/orgs?offset=0&limit=20&descending=false&org=string&orgID=string&userID=string
  • POSTCreate an organization/orgs
  • GETRetrieve an organization/orgs/:orgID
  • DELETEDelete an organization/orgs/:orgID
  • PATCHUpdate an organization/orgs/:orgID
  • GETList all members of an organization/orgs/:orgID/members
  • POSTAdd a member to an organization/orgs/:orgID/members
  • DELETERemove a member from an organization/orgs/:orgID/members/:userID
  • GETList all owners of an organization/orgs/:orgID/owners
  • POSTAdd an owner to an organization/orgs/:orgID/owners
  • DELETERemove an owner from an organization/orgs/:orgID/owners/:userID

Secrets

  • GETList all secret keys for an organization/orgs/:orgID/secrets
  • PATCHUpdate secrets in an organization/orgs/:orgID/secrets
  • POSTDelete secrets from an organization/orgs/:orgID/secrets/delete

Query

  • POSTQuery InfluxDB/query?org=string&orgID=string
  • POSTAnalyze an InfluxQL or Flux query/query/analyze
  • POSTGenerate an Abstract Syntax Tree (AST) from a query/query/astAnalyzes flux query and generates a query specification.
  • GETRetrieve query suggestions/query/suggestions
  • GETRetrieve query suggestions for a branching suggestion/query/suggestions/:name

Ready

  • GETGet the readiness of an instance at startup/ready

Scraper Targets

  • GETList all scraper targets/scrapers?name=string&id=string&orgID=string&org=string
  • POSTCreate a scraper target/scrapers
  • GETRetrieve a scraper target/scrapers/:scraperTargetID
  • DELETEDelete a scraper target/scrapers/:scraperTargetID
  • PATCHUpdate a scraper target/scrapers/:scraperTargetID
  • GETList all labels for a scraper target/scrapers/:scraperTargetID/labels
  • POSTAdd a label to a scraper target/scrapers/:scraperTargetID/labels
  • DELETEDelete a label from a scraper target/scrapers/:scraperTargetID/labels/:labelID
  • GETList all users with member privileges for a scraper target/scrapers/:scraperTargetID/members
  • POSTAdd a member to a scraper target/scrapers/:scraperTargetID/members
  • DELETERemove a member from a scraper target/scrapers/:scraperTargetID/members/:userID
  • GETList all owners of a scraper target/scrapers/:scraperTargetID/owners
  • POSTAdd an owner to a scraper target/scrapers/:scraperTargetID/owners
  • DELETERemove an owner from a scraper target/scrapers/:scraperTargetID/owners/:userID

Setup

  • GETCheck if database has default user, org, bucket/setupReturns true if no default user, organization, or bucket has been created.
  • POSTSet up initial user, org and bucket/setupPost an onboarding request to set up initial user, org and bucket.

Sources

  • GETList all sources/sources?org=string
  • POSTCreate a source/sources
  • GETRetrieve a source/sources/:sourceID
  • DELETEDelete a source/sources/:sourceID
  • PATCHUpdate a Source/sources/:sourceID
  • GETGet buckets in a source/sources/:sourceID/buckets?org=string
  • GETGet the health of a source/sources/:sourceID/health

InfluxDB Templates

  • GETList all installed InfluxDB templates/stacks?orgID=string&name=string&stackID=string
  • POSTCreate a new stack/stacks
  • GETRetrieve a stack/stacks/:stack_id
  • DELETEDelete a stack and associated resources/stacks/:stack_id?orgID=string
  • PATCHUpdate an InfluxDB Stack/stacks/:stack_id
  • POSTUninstall an InfluxDB Stack/stacks/:stack_id/uninstall
  • POSTApply or dry-run an InfluxDB Template/templates/apply
  • POSTExport a new Influx Template/templates/export

Tasks

  • GETList all tasks/tasks?name=string&after=string&user=string&org=string&orgID=string&status=active&limit=100
  • POSTCreate a new task/tasks
  • GETRetrieve a task/tasks/:taskID
  • DELETEDelete a task/tasks/:taskIDDeletes a task and all associated records
  • PATCHUpdate a task/tasks/:taskIDUpdate a task. This will cancel all queued runs.
  • GETList all labels for a task/tasks/:taskID/labels
  • POSTAdd a label to a task/tasks/:taskID/labels
  • DELETEDelete a label from a task/tasks/:taskID/labels/:labelID
  • GETRetrieve all logs for a task/tasks/:taskID/logs
  • GETList all task members/tasks/:taskID/members
  • POSTAdd a member to a task/tasks/:taskID/members
  • DELETERemove a member from a task/tasks/:taskID/members/:userID
  • GETList all owners of a task/tasks/:taskID/owners
  • POSTAdd an owner to a task/tasks/:taskID/owners
  • DELETERemove an owner from a task/tasks/:taskID/owners/:userID
  • GETList runs for a task/tasks/:taskID/runs?after=string&limit=100&afterTime=2024-01-01T00:00:00Z&beforeTime=2024-01-01T00:00:00Z
  • POSTManually start a task run, overriding the current schedule/tasks/:taskID/runs
  • GETRetrieve a single run for a task/tasks/:taskID/runs/:runID
  • DELETECancel a running task/tasks/:taskID/runs/:runID
  • GETRetrieve all logs for a run/tasks/:taskID/runs/:runID/logs
  • POSTRetry a task run/tasks/:taskID/runs/:runID/retry

Telegraf Plugins

  • GETList all Telegraf plugins/telegraf/plugins?type=string

Telegrafs

  • GETList all Telegraf configurations/telegrafs?orgID=string
  • POSTCreate a Telegraf configuration/telegrafs
  • GETRetrieve a Telegraf configuration/telegrafs/:telegrafID
  • PUTUpdate a Telegraf configuration/telegrafs/:telegrafID
  • DELETEDelete a Telegraf configuration/telegrafs/:telegrafID
  • GETList all labels for a Telegraf config/telegrafs/:telegrafID/labels
  • POSTAdd a label to a Telegraf config/telegrafs/:telegrafID/labels
  • DELETEDelete a label from a Telegraf config/telegrafs/:telegrafID/labels/:labelID
  • GETList all users with member privileges for a Telegraf config/telegrafs/:telegrafID/members
  • POSTAdd a member to a Telegraf config/telegrafs/:telegrafID/members
  • DELETERemove a member from a Telegraf config/telegrafs/:telegrafID/members/:userID
  • GETList all owners of a Telegraf configuration/telegrafs/:telegrafID/owners
  • POSTAdd an owner to a Telegraf configuration/telegrafs/:telegrafID/owners
  • DELETERemove an owner from a Telegraf config/telegrafs/:telegrafID/owners/:userID

Variables

  • GETList all variables/variables?org=string&orgID=string
  • POSTCreate a variable/variables
  • GETRetrieve a variable/variables/:variableID
  • PUTReplace a variable/variables/:variableID
  • DELETEDelete a variable/variables/:variableID
  • PATCHUpdate a variable/variables/:variableID
  • GETList all labels for a variable/variables/:variableID/labels
  • POSTAdd a label to a variable/variables/:variableID/labels
  • DELETEDelete a label from a variable/variables/:variableID/labels/:labelID

Write

  • POSTWrite time series data into InfluxDB/write?org=string&orgID=string&bucket=string&precision=ms
  • POSTExchange basic auth credentials for session/signin
  • POSTExpire the current session/signout

API details

Authentication
HTTP Basic authentication (username and password)
Operations
197 operations on 113 pathsGET 75POST 55DELETE 41PATCH 18PUT 8
Main resources
Tasks 21Dashboards 20Buckets 15Organizations 14Scraper Targets 14Telegrafs 14Checks 10NotificationEndpoints 9NotificationRules 9Users 9
Response formats
application/json application/octet-stream application/toml application/vnd.influx.arrow
Description format
OpenAPI 3.0.0, API version 2.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Influx OSS API Service in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Influx OSS API Service collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List all top level routes” (GET /), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Influx OSS API Service?

Authentication <!-- ReDoc-Inject: <security-definitions> --> It is listed under IoT & devices and has 197 endpoints.

Who publishes the Influx OSS API Service?

It is listed from Influxdata's public API description (an OpenAPI document), not published by Influxdata on Swastik Codes. Anyone who controls influxdata.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Influx OSS API Service?

With HTTP Basic authentication (username and password).

How many endpoints does the Influx OSS API Service have?

197 operations on 113 paths (75 GET, 55 POST, 41 DELETE, 18 PATCH, 8 PUT). The largest groups are Tasks, Dashboards, Buckets, Organizations.

Is forking the Influx OSS API Service free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.