System

This Piiano Vault REST API resource enables you to retrieve details about the status of system components and the Vault version.

Get data service health/status

get/api/pvlt/1.0/data/info/health

Gets the status of the service.

Get control service health/status

get/api/pvlt/1.0/ctl/info/health

Gets the status of the service.

Get cluster information

get/api/pvlt/1.0/ctl/info/cluster

Get Cluster Information.

Delete objects and tokens

post/api/pvlt/1.0/system/admin/lifecycle/gc

Deletes archived objects and tokens that have been archived for longer than the retention period.

Trigger an artificial error

post/api/pvlt/1.0/system/debug/error/trigger

Manually trigger an artificial error for testing purposes.

Get system configuration

get/api/pvlt/1.0/system/info/configuration

Get the current active system configuration.

Get license

get/api/pvlt/1.0/system/info/license

Gets information on the currently used license.

Get Vault version

get/api/pvlt/1.0/system/info/version

Gets the version of Vault.

Rotate data encryption keys

post/api/pvlt/1.0/system/admin/keys/rotate

Rotates all the KMS keys that Vault uses to encrypt properties, tokens, and more.

Get KMS status

get/api/pvlt/1.0/system/info/kms

Gets the status of the configured KMS.