Set up internal Kapacitor authorizations

Use user-based authorizations and permissions stored in Kapacitor to authenticate requests to the Kapacitor HTTP API.

Use Kapacitor authorizations

  1. Create an admin user:

    1. Set the following in the [auth] configuration group in your kapacitor.conf:

      • enabled: true
      • bcrypt: an integer greater than or equal to 4
      • meta-*: empty string or false
        enabled = true
        cache-expiration = "1h"
        bcrypt-cost = 4
        meta-addr = ""
        meta-username = ""
        meta-password = ""
        meta-use-tls = false
        meta-ca = ""
        meta-cert = ""
        meta-key = ""
        meta-insecure-skip-verify = false

      Or use environment variables to set these configuration options:

      export KAPACITOR_AUTH_ENABLED=true
    2. Start kapacitord using the updated configuration:

      kapactord -config /path/to/kapacitor.conf
    3. Use the /users endpoint of the Kapacitor HTTP API to create a new admin user. In the request body, provide a JSON object with the following fields:

      • name: admin username
      • password: admin password
      • type: "admin"
      curl --request POST 'http://localhost:9092/kapacitor/v1/users' \
        --data '{
          "name": "exampleUsername",
          "password": "examplePassword",
  2. Stop the kapacitord service.

  3. Set [http].auth-enabled to true in your kapacitor.conf:

      auth-enabled: true

    Or use the KAPACITOR_HTTP_AUTH_ENABLED environment variable:

  4. Restart kapacitord with the updated configuration.

    kapacitord -config /path/to/kapacitor.conf
  5. (Optional) Create additional users with user-specific permissions. For more information, see:

Authenticate with the Kapacitor CLI

To authenticate with Kapacitor when using the kapacitor CLI, provide your username and password as part of the Kapacitor -url:

# Syntax
kapacitor -url http://<username>:<password>@localhost:9092

# Example
kapacitor -url http://admin:Pa5sw0Rd@localhost:9092

Authenticate with the Kapacitor API

To authenticate directly with the Kapacitor API, use basic authentication to provide your username and password.

# Syntax
curl --request GET http://localhost:9092/kapacitor/v1/tasks \
  -u "<username>:<password>" 

# Example
curl --request GET http://localhost:9092/kapacitor/v1/tasks \
  -u "johndoe:Pa5sw0Rd" 

Was this page helpful?

Thank you for your feedback!

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: