Documentation

Module: mounts

Provides implementation for the Vault Secret Backend Mounts APIs

Extends

  • Vaulted

Methods

<inner> createMount()

Creates the specified mount in the vault and sets internal property accordingly

Parameters:
Name Type Argument Description
options.id string

unique identifier for the secret backend mount
options.body.type string

the type of secret backend ('consul', 'pki')
options.body.description string <optional>

a description of the secret backend for operators.
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> deleteMount()

Deletes the specified mount from the vault and sets internal property accordingly

Parameters:
Name Type Argument Description
options.id string

unique identifier for the secret backend mount
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> getMounts()

Gets the list of mounts for the vault and sets internal property accordingly

Parameters:
Name Type Argument Description
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> getMountTune()

Gets the current TTL config for a mount

Parameters:
Name Type Argument Description
options.id string

unique identifier for the secret backend mount
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> mountConsul()

Convenience method to enable the consul secret backend for use with the vault.

Parameters:
Name Type Argument Default Description
options.id string <optional>
 consul

unique identifier for the secret backend mount
options.body.description string <optional>

a description of the secret backend for operators.
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> mountPki()

Convenience method to enable the pki secret backend for use with the vault.

Parameters:
Name Type Argument Default Description
options.id string <optional>
 pki

unique identifier for the secret backend mount
options.body.description string <optional>

a description of the secret backend for operators.
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> mountTransit()

Convenience method to enable the transit secret backend for use with the vault.

Parameters:
Name Type Argument Default Description
options.id string <optional>
 transit

unique identifier for the secret backend mount
options.body.description string <optional>

a description of the secret backend for operators.
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> reMount()

Renames the specified mount to a new name in the vault and sets internal property accordingly

Parameters:
Name Type Argument Description
options.from string

current unique identifier for the secret backend mount
options.to string

new unique identifier for the secret backend mount
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> tuneMount()

Tunes the TTL config of an existing mount

Parameters:
Name Type Argument Description
options.id string

unique identifier for the secret backend mount
options.body.default_lease_ttl string <optional>

the default lease TTL as a string
options.body.max_lease_ttl string <optional>

the maximum value to set a ttl as a string
options.token string <optional>

the authentication token
Returns:
Type
Promise