NAME

OpenXPKI::Server::API2::Plugin::Datapool::get_datavault_status

COMMANDS

get_datavault_status

Check if the datavault token for datapool encryption is available, both parameters are optional.

    my $info = CTX('api2')->get_data_pool_entry(
        alias => 'vault-1',
        check_online => 1,
    );

Returns:

    {
        alias => 'vault-1', # token alias of the current asymmetric token
        key_expiry => '', # expiration of the symmetric key (if set)
        key_id => 'Wdm/5PAwH8yHXgXjWVm7wMikeTM', # id of the active symmetric key
        online => 1, # result of the token online test, only if check_online was set
    }

Retunrs an empty hash if no active vault token is found. key_id might be empty if there is no active encryption key.

Parameters

"alias" - the alias of the vault token, default is to query the active token
"check_online" Bool - do a crypto operation to check usability of the key