Documentation

Use Postman with the InfluxDB API

Use Postman, a popular tool for exploring APIs, to interact with the InfluxDB API.

Install Postman

Download Postman from the official downloads page.

Or to install with Homebrew on macOS, run the following command:

brew cask install postman

Send authenticated API requests with Postman

All requests to the InfluxDB API must be authenticated. Postman lets you configure the headers and body of HTTP requests.

Use the Authorization tab in Postman to include the credentials required when interacting with the InfluxDB API.

  1. If you have not already, create a token.
  2. In the Authorization tab, select API Key in the Type dropdown.
  3. For Key, enter Authorization.
  4. For Value, enter Token <token string>, replacing <token string> with the token generated in step 1.
  5. Ensure that the Add to option is set to Header.

Test authentication credentials

To test the authentication, enter the /health endpoint of an InfluxDB OSS or InfluxDB Cloud instance into the address bar and click Send.

InfluxDB API health endpoint
https://cloud2.influxdata.com/api/v2/health

New! Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: