walletpassphrase

Back to wallet

Wallet

Summary

Stores the wallet decryption key in memory for 'timeout' seconds.

Description

Stores the wallet decryption key in memory for 'timeout' seconds. This is needed prior to performing transactions related to private keys such as sending QBT

Note: Issuing the walletpassphrase command while the wallet is already unlocked will set a new unlock time that overrides the old one.

Arguments

  • passphrase (STR, required): The wallet passphrase
  • timeout (NUM, required): The time to keep the decryption key in seconds; capped at 100000000 (~3 years).

Results

  • value (NONE): No description.

Examples

Unlock the wallet for 60 seconds

qbit-cli walletpassphrase "my pass phrase" 60

Lock the wallet again (before 60 seconds)

qbit-cli walletlock

As a JSON-RPC call

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "walletpassphrase", "params": ["my pass phrase", 60]}' -H 'content-type: application/json' http://127.0.0.1:8352/