InfluxDB HTTP API

Quick start

Get started writing and querying data with the InfluxDB 3 Cloud Serverless API.

API compatibility

InfluxDB Cloud Serverless supports a subset of the InfluxDB v2 API. Other endpoints in this reference are for the InfluxDB Cloud (TSM) API — they may be accessible, but are not supported or…

Authentication

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

Common parameters

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

Headers

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

Pagination

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

Response codes

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

Supported operations

The InfluxDB 3 Cloud Serverless 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 3 Cloud Serverless organization resources.

Buckets

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

DBRPs

Create and manage database retention policy (DBRP) mappings for InfluxDB Cloud Serverless. DBRP mappings associate v1-compatible database and retention policy combinations with Cloud Serverless…

Limits

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

Organizations

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

Query data

Query data stored in InfluxDB 3 Cloud Serverless using InfluxQL via the v1-compatible /query endpoint, or using SQL and InfluxQL via Flight+gRPC clients.

Usage

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

Write data

Write time series data to InfluxDB 3 Cloud Serverless buckets using the v2-compatible /api/v2/write endpoint or the v1-compatible /write endpoint with line protocol.