InfluxDB HTTP API

Quick start

Authenticate, write, and query with the InfluxDB Cloud API:

Authentication

Use one of the following schemes to authenticate to the InfluxDB Cloud API:

Common parameters

Most InfluxDB Cloud API endpoints require parameters in the request–for example, to specify the bucket or organization.

Headers

InfluxDB Cloud API endpoints use standard HTTP request and response headers. The following table shows common headers used by many InfluxDB Cloud API endpoints. Some endpoints may use other headers…

Pagination

List endpoints in the InfluxDB Cloud API support pagination via query parameters. Use these parameters to page through large result sets.

Response codes

InfluxDB Cloud API endpoints return standard HTTP status codes. The following table summarizes the most common response codes.

Supported operations

The InfluxDB Cloud API supports create, read, update, and delete operations on resources. Most endpoints follow standard HTTP method conventions:

Authorizations (API tokens)

Create and manage API token authorizations that grant read and write permissions to InfluxDB Cloud organization resources.

Bucket Schemas

Manage explicit schemas for InfluxDB Cloud buckets to enforce column names and data types for measurement data.

Buckets

Create and manage named storage locations (buckets) in InfluxDB Cloud, each with a configurable retention period.

Cells

Manage cells within InfluxDB Cloud dashboards.

Checks

Create and manage monitoring checks that query data on a schedule and generate notification statuses in InfluxDB Cloud.

Config

Retrieve configuration information for an InfluxDB Cloud instance.

Dashboards

Create and manage dashboards in InfluxDB Cloud.

DBRPs

Manage database and retention policy (DBRP) mappings that route InfluxDB v1-compatible requests to InfluxDB Cloud buckets.

Delete

Delete time series data from an InfluxDB Cloud bucket by specifying a time range and optional tag predicate.

Invokable Scripts

Store, manage, and execute custom Flux scripts in InfluxDB Cloud. Scripts accept runtime parameters and can be invoked via dedicated endpoints.

Labels

Create and manage labels for organizing InfluxDB Cloud resources such as dashboards, tasks, and buckets.

Legacy Authorizations

Manage legacy (v1-compatible) authorization credentials in InfluxDB Cloud.

Legacy Query

Query data using InfluxQL via the v1-compatible /query endpoint in InfluxDB Cloud.

Legacy Write

Write data using the v1-compatible /write endpoint in InfluxDB Cloud.

Limits

Retrieve rate limits and usage quotas for an InfluxDB Cloud organization.

NotificationEndpoints

Create and manage notification endpoints that receive alert notifications from InfluxDB Cloud monitoring checks.

NotificationRules

Create and manage notification rules that define when and how InfluxDB Cloud sends notifications to configured endpoints.

Organizations

View and manage InfluxDB Cloud organizations, which are workspaces that group users, buckets, and resources.

Ping

Check the availability of the InfluxDB Cloud instance.

Query data

Retrieve data, analyze queries, and get query suggestions using the InfluxDB Cloud query API.

Resources

Retrieve a list of top-level resource types available in the InfluxDB Cloud API.

Routes

Retrieve top-level routes for the InfluxDB Cloud API.

Rules

Manage notification rules in InfluxDB Cloud.

Secrets

Create and manage secrets (key-value pairs) for use in InfluxDB Cloud Flux scripts and tasks.

Security and access endpoints

Endpoints for managing authentication and access control in InfluxDB Cloud.

Setup

Configure an initial InfluxDB Cloud instance, including creating the initial user, organization, and bucket.

Signin

Create a user session by signing in with username and password credentials.

Signout

End a user session by signing out.

System information endpoints

Endpoints for retrieving system-level information about the InfluxDB Cloud instance.

Tasks

Schedule and manage Flux tasks that process and transform data on a recurring basis in InfluxDB Cloud.

Telegraf Plugins

Retrieve available Telegraf plugin configuration templates for use with InfluxDB Cloud.

Telegrafs

Create and manage Telegraf agent configurations that collect and write data to InfluxDB Cloud.

Templates

Export and apply InfluxDB templates, and manage template stacks for InfluxDB Cloud.

Usage

Retrieve usage metrics and cardinality data for an InfluxDB Cloud organization.

Users

View specific users that are members of your InfluxDB Cloud organization.

Variables

Create and manage variables for use in InfluxDB Cloud dashboards.

Views

Manage cell views within InfluxDB Cloud dashboards.

Write data

Write time series data to InfluxDB Cloud buckets in line protocol format using the /api/v2/write endpoint.