InfluxElixir.Admin.Tokens (InfluxElixir v0.1.15)

v3 token management via /api/v3/configure/token.

Delegates to the configured InfluxElixir.Client implementation. Use this module to create and delete API tokens in InfluxDB v3.

Examples

{:ok, conn} = InfluxElixir.Client.Local.start()

{:ok, token} = InfluxElixir.Admin.Tokens.create(conn, "my token")
:ok = InfluxElixir.Admin.Tokens.delete(conn, token["id"])

Summary

Functions

create(connection, description, opts \\ [])

Creates an API token in InfluxDB v3.

delete(connection, token_id)

Deletes an API token in InfluxDB v3.

Functions

create(connection, description, opts \\ [])

@spec create(InfluxElixir.Client.connection(), binary(), keyword()) ::
  {:ok, map()} | {:error, term()}

Creates an API token in InfluxDB v3.

Parameters

connection - a client connection term
description - human-readable description for the token
opts - optional keyword list (e.g. :permissions)

Returns

{:ok, map()} containing token details on success
{:error, reason} on failure

delete(connection, token_id)

@spec delete(InfluxElixir.Client.connection(), binary()) :: :ok | {:error, term()}

Deletes an API token in InfluxDB v3.

Parameters

connection - a client connection term
token_id - the ID of the token to delete

Returns

:ok on success
{:error, reason} on failure