Sys

class SysEndpoint(req_handler)
task status()

Return the initialization status of a Vault

Returns:Status – vault server status
task initialize(secret_shares, secret_threshold)

Initializes a new Vault.

The Vault must’ve not been previously initialized

Parameters:
  • secret_shares (int) – The number of shares to split the master key into.
  • secret_threshold (int) – The number of shares required to reconstruct the master key. This must be less than or equal to secret_shares.
Returns:

Initial – Includes the master keys and initial root token

task leader()

Returns the high availability status and current leader instance of Vault.

Returns:HighAvailibility – High availibility status
task health(*, standbyok=False)

Returns the health status of Vault.

This matches the semantics of a Consul HTTP health check and provides a simple way to monitor the health of a Vault instance.

Returns:Health – health status

Objects

class Status(*, initialized)
class Initial(*, root_token, keys)

Implements master initiales.

Variables:
  • root_token (str) – The root token
  • keys (tuple) – The secret keys
class HighAvailibility(*, ha_enabled, is_self, leader_address)
class Health(*, initialized, sealed, standby)