open-vault/website/source/api/secret/databases/postgresql.html.md

layout	page_title	sidebar_current	description
api	PostgreSQL Database Plugin - HTTP API	docs-http-secret-databases-postgresql-maria	The PostgreSQL plugin for Vault's Database backend generates database credentials to access PostgreSQL servers.

PostgreSQL Database Plugin HTTP API

The PostgreSQL Database Plugin is one of the supported plugins for the Database backend. This plugin generates database credentials dynamically based on configured roles for the PostgreSQL database.

Configure Connection

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

Method	Path	Produces
POST	/database/config/:name	204 (empty body)

Parameters

• connection_url (string: <required>) - Specifies the PostgreSQL DSN.

• max_open_connections (int: 2) - Speficies the name of the plugin to use for this connection.

• max_idle_connections (int: 0) - Specifies the maximum number of idle connections to the database. A zero uses the value of max_open_connections and a negative value disables idle connections. If larger than max_open_connections it will be reduced to be equal.

• max_connection_lifetime (string: "0s") - Specifies the maximum amount of time a connection may be reused. If <= 0s connections are reused forever.

Sample Payload

{
  "plugin_name": "postgresql-database-plugin",
  "allowed_roles": "readonly",
  "connection_url": "postgresql://root:root@localhost:5432/postgres",
  "max_open_connections": 5,
  "max_connection_lifetime": "5s",
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    https://vault.rocks/v1/database/config/postgresql