# Influxdb database plugin HTTP API

The Influxdb database plugin is one of the supported plugins for the database secrets engine. This plugin generates database credentials dynamically based on configured roles for the Influxdb database.

### Configure connection <a href="#configure-connection" id="configure-connection"></a>

In addition to the parameters defined by the Database Secrets Engine, this plugin has a number of parameters to further configure a connection.

| Method | Path                     |
| ------ | ------------------------ |
| `POST` | `/database/config/:name` |

#### Parameters <a href="#parameters" id="parameters"></a>

* `host` `(string: <required>)` – Specifies a Influxdb host to connect to.
* `port` `(int: 8086)` – Specifies the default port to use if none is provided as part of the host URI. Defaults to Influxdb's default transport port, 8086.
* `username` `(string: <required>)` – Specifies the username to use for superuser access.
* `password` `(string: <required>)` – Specifies the password corresponding to the given username.
* `tls` `(bool: true)` – Specifies whether to use TLS when connecting to Influxdb.
* `insecure_tls` `(bool: false)` – Specifies whether to skip verification of the server certificate when using TLS.
* `pem_bundle` `(string: "")` – Specifies concatenated PEM blocks containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate.
* `pem_json` `(string: "")` – Specifies JSON containing a certificate and private key; a certificate, private key, and issuing CA certificate; or just a CA certificate. For convenience format is the same as the output of the `issue` command from the `pki` secrets engine; see the pki documentation.
* `connect_timeout` `(string: "5s")` – Specifies the connection timeout to use.
* `username_template` `(string)` - Template describing how dynamic usernames are generated.

TLS works as follows:

* If `tls` is set to true, the connection will use TLS; this happens automatically if `pem_bundle`, `pem_json`, or `insecure_tls` is set
* If `insecure_tls` is set to true, the connection will not perform verification of the server certificate; this also sets `tls` to true
* If only `issuing_ca` is set in `pem_json`, or the only certificate in `pem_bundle` is a CA certificate, the given CA certificate will be used for server certificate verification; otherwise the system CA certificates will be used
* If `certificate` and `private_key` are set in `pem_bundle` or `pem_json`, client auth will be turned on for the connection

`pem_bundle` should be a PEM-concatenated bundle of a private key + client certificate, an issuing CA certificate, or both. `pem_json` should contain the same information; for convenience, the JSON format is the same as that output by the issue command from the PKI secrets engine.

#### Sample payload <a href="#sample-payload" id="sample-payload"></a>

```json
{
  "plugin_name": "influxdb-database-plugin",
  "allowed_roles": "readonly",
  "host": "influxdb1.local",
  "username": "user",
  "password": "pass"
}
```

#### Sample request <a href="#sample-request" id="sample-request"></a>

```shell-session
$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/influxdb/config/connection
```

### Statements <a href="#statements" id="statements"></a>

Statements are configured during role creation and are used by the plugin to determine what is sent to the database on user creation, renewing, and revocation. For more information on configuring roles see the Role API in the database secrets engine docs.

#### Parameters <a href="#parameters-1" id="parameters-1"></a>

The following are the statements used by this plugin. If not mentioned in this list the plugin does not support that statement type.

* `creation_statements` `(list: [])` – Specifies the database statements executed to create and configure a user. Must be a semicolon-separated string, a base64-encoded semicolon-separated string, a serialized JSON string array, or a base64-encoded serialized JSON string array. The `{{username}}` and `{{password}}` values will be substituted. If not provided, defaults to a generic create user statements that creates a non-superuser.
* `revocation_statements` `(list: [])` – Specifies the database statements to be executed to revoke a user. Must be a semicolon-separated string, a base64-encoded semicolon-separated string, a serialized JSON string array, or a base64-encoded serialized JSON string array. The `{{username}}` value will be substituted. If not provided defaults to a generic drop user statement.
* `rollback_statements` `(list: [])` – Specifies the database statements to be executed to rollback a create operation in the event of an error. Must be a semicolon-separated string, a base64-encoded semicolon-separated string, a serialized JSON string array, or a base64-encoded serialized JSON string array. The `{{username}}` value will be substituted. If not provided, defaults to a generic drop user statement.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.enclaive.cloud/vault/api/secrets-engines/database/influxdb-database-plugin-http-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.