» PostgreSQL Secrets Engine (API)

This is the API documentation for the Vault PostgreSQL secrets engine. For general information about the usage and operation of the PostgreSQL secrets engine, please see the PostgreSQL documentation.

This documentation assumes the PostgreSQL secrets engine is enabled at the /postgresql path in Vault. Since it is possible to enable secrets engines at any location, please update your API calls accordingly.

» Configure Connection

This endpoint configures the connection string used to communicate with PostgreSQL.

Method Path Produces
POST /postgresql/config/connection 204 (empty body)

» Parameters

  • connection_url (string: <required>) – Specifies the PostgreSQL connection URL or PG-style string, for example "user=foo host=bar".

  • max_open_connections (int: 2) – Specifies the maximum number of open connections to the database. A negative value means unlimited.

  • 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 this is larger than max_open_connections it will be reduced to be equal.

  • verify_connection (bool: true) – Specifies if the connection is verified during initial configuration.

» Sample Payload

{
  "connection_url": "postgresql://user:pass@localhost/my-db"
}

» Sample Request

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

» Configure Lease

This configures the lease settings for generated credentials. If not configured, leases default to 1 hour. This is a root protected endpoint.

Method Path Produces
POST /postgresql/config/lease 204 (empty body)

» Parameters

  • lease (string: <required>) – Specifies the lease value provided as a string duration with time suffix. "h" (hour) is the largest suffix.

  • lease_max (string: <required>) – Specifies the maximum lease value provided as a string duration with time suffix. "h" (hour) is the largest suffix.

» Sample Payload

{
  "lease": "12h",
  "lease_max": "24h"
}

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/postgresql/config/lease

» Create Role

This endpoint creates or updates a role definition.

Method Path Produces
POST /postgresql/roles/:name 204 (empty body)

» Parameters

  • name (string: <required>) – Specifies the name of the role to create. This is specified as part of the URL.

  • sql (string: <required>) – Specifies the SQL statements executed to create and configure the role. 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 '{{name}}', '{{password}}' and '{{expiration}}' values will be substituted.

  • revocation_sql (string: "") – Specifies the SQL 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 '{{name}}' value will be substituted.

» Sample Payload

{
  "sql": "CREATE USER WITH ROLE {{name}}"
}

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    http://127.0.0.1:8200/v1/postgresql/roles/my-role

» Read Role

This endpoint queries the role definition.

Method Path Produces
GET /postgresql/roles/:name 200 application/json

» Parameters

  • name (string: <required>) – Specifies the name of the role to read. This is specified as part of the URL.

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/postgresql/roles/my-role

» Sample Response

{
  "data": {
    "sql": "CREATE USER..."
  }
}

» List Roles

This endpoint returns a list of available roles. Only the role names are returned, not any values.

Method Path Produces
LIST /postgresql/roles 200 application/json

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request LIST \
    http://127.0.0.1:8200/v1/postgresql/roles

» Sample Response

{
  "auth": null,
  "data": {
    "keys": ["dev", "prod"]
  },
  "lease_duration": 2764800,
  "lease_id": "",
  "renewable": false
}

» Delete Role

This endpoint deletes the role definition.

Method Path Produces
DELETE /postgresql/roles/:name 204 (empty body)

» Parameters

  • name (string: <required>) – Specifies the name of the role to delete. This is specified as part of the URL.

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request DELETE \
    http://127.0.0.1:8200/v1/postgresql/roles/my-role

» Generate Credentials

This endpoint generates a new set of dynamic credentials based on the named role.

Method Path Produces
GET /postgresql/creds/:name 200 application/json

» Parameters

  • name (string: <required>) – Specifies the name of the role to create credentials against. This is specified as part of the URL.

» Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    http://127.0.0.1:8200/v1/postgresql/creds/my-role

» Sample Response

{
  "data": {
    "username": "root-1430158508-126",
    "password": "132ae3ef-5a64-7499-351e-bfe59f3a2a21"
  }
}