InfluxDB Cloud API Service

Routes /api/v2

Authorizations (API tokens) /api/v2/authorizations

Create and manage authorizations (API tokens).

An authorization contains a list of read and write permissions for organization resources and provides an API token for authentication. An authorization belongs to an organization and only contains permissions for that organization.

We recommend the following for managing your tokens:

• Create a generic user to create and manage tokens for writing data.
• Store your tokens in a secure password vault for future access.

User sessions with authorizations

Optionally, when creating an authorization, you can scope it to a specific user. If the user signs in with username and password, creating a user session, the session carries the permissions granted by all the user’s authorizations. For more information, see how to assign a token to a specific user. To create a user session, use the POST /api/v2/signin endpoint.

Buckets /api/v2/buckets

Store your data in InfluxDB buckets. A bucket is a named location where time series data is stored. All buckets have a retention period, a duration of time that each data point persists. InfluxDB drops all points with timestamps older than the bucket’s retention period. A bucket belongs to an organization.

Checks /api/v2/checks

Dashboards /api/v2/dashboards

DBRPs /api/v2/dbrps

The InfluxDB 1.x data model includes databases and retention policies. InfluxDB 2.x replaces databases and retention policies with buckets. To support InfluxDB 1.x query and write patterns in InfluxDB 2.x, databases and retention policies are mapped to buckets using the database and retention policy (DBRP) mapping service. The DBRP mapping service uses the database and retention policy specified in 1.x compatibility API requests to route operations to a bucket.

Data I/O endpoints /api/v2/delete

Config /api/v2/flags

Labels /api/v2/labels

/api/v2/maps

InfluxDB API documentation

Users /api/v2/me

Retrieve specific users.

InfluxDB Cloud lets you invite and collaborate with multiple users in your organization. To invite and remove users from your organization, use the InfluxDB Cloud user interface (UI); you can’t use the InfluxDB API to manage users in InfluxDB Cloud. Once a user is added to your organization, you can use the GET /api/v2/users and GET /api/v2/users/USER_ID API endpoints to view specific members.

User sessions with authorizations

Optionally, you can scope an authorization (and its API token) to a user. If a user signs in with username and password, creating a user session, the session carries the permissions granted by all the user’s authorizations. To create a user session, use the POST /api/v2/signin endpoint.

NotificationEndpoints /api/v2/notificationEndpoints

NotificationRules /api/v2/notificationRules

Organizations /api/v2/orgs

Manage your organization. An organization is a workspace for a group of users. Organizations can be used to separate different environments, projects, teams or users within InfluxDB.

Use the /api/v2/orgs endpoints to view and manage organizations.

Data I/O endpoints /api/v2/query

Resources /api/v2/resources

Data I/O endpoints /api/v2/scripts

Setup /api/v2/setup

Security and access endpoints /api/v2/signin

Security and access endpoints /api/v2/signout

Templates /api/v2/stacks

Export and apply InfluxDB templates. Manage stacks of templated InfluxDB resources.

InfluxDB templates are prepackaged configurations for resources. Use InfluxDB templates to configure a fresh instance of InfluxDB, back up your dashboard configuration, or share your configuration.

Use the /api/v2/templates endpoints to export templates and apply templates.

InfluxDB stacks are stateful InfluxDB templates that let you add, update, and remove installed template resources over time, avoid duplicating resources when applying the same or similar templates more than once, and apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.

Use the /api/v2/stacks endpoints to manage installed template resources.

Data I/O endpoints /api/v2/tasks

Telegraf Plugins /api/v2/telegraf

Telegrafs /api/v2/telegrafs

Templates /api/v2/templates

Export and apply InfluxDB templates. Manage stacks of templated InfluxDB resources.

InfluxDB templates are prepackaged configurations for resources. Use InfluxDB templates to configure a fresh instance of InfluxDB, back up your dashboard configuration, or share your configuration.

Use the /api/v2/templates endpoints to export templates and apply templates.

InfluxDB stacks are stateful InfluxDB templates that let you add, update, and remove installed template resources over time, avoid duplicating resources when applying the same or similar templates more than once, and apply changes to distributed instances of InfluxDB OSS or InfluxDB Cloud.

Use the /api/v2/stacks endpoints to manage installed template resources.

Security and access endpoints /api/v2/users

Variables /api/v2/variables

Data I/O endpoints /api/v2/write

Legacy Authorizations /legacy/authorizations

Ping /ping

Legacy Query /query

Legacy Write /write