Get Vault Status

The Get Vault Status endpoint provides real-time information about the status and configuration of your self-hosted Signchain Vault. This endpoint is useful for monitoring the operational health of your Vault instance.

Endpoint

GET/api/v1/vaults/:vaultId/status

Test Endpoint

Request Parameters

vaultId (string, required): The unique identifier of the Vault you wish to check. This should correspond to the Vault ID as configured in your Signchain Dashboard.

Example Request

curl -X GET https://signchain.net/api/v1/vault/{vaultId}/status \
     -H "Authorization: Bearer <API_KEY>"

Response

The response will include relevant details about the current state of the Vault, including the number of vault keys configured, the number of active wallets, version information of the vault instance, and any errors encountered.

Example Response

{
  "timestamp": "<Current-Timestamp-At-Vault-ISO>",
  "online": Online_Status,
  "vaultKeys": Number_Of_Vault_Keys,
  "wallets": Number_Of_Wallets,
  "version": "<Version-Of-Signchain-Vault>"
}

Fields

timestamp: The ISO 8601 timestamp as a string of the current Vault's time when the status was reported.
online: Boolean true or false indicating whether the Vault is online or not.
vaultKeys: A number giving the count of Vault Keys configured for the vault
wallets: Number of wallets contained in the Vault for your account.
version: The version identifier (usually a Git hash) of the Signchain Vault instance.

Usage Notes

The Get Vault Status endpoint is primarily intended for monitoring and diagnostics. Use it to verify that your Vault is running and configured correctly before performing critical operations.

By using this endpoint, you can proactively ensure the reliability and security of your self-hosted Signchain Vault.

Signchain Docs