restorewallet

restorewallet "wallet_name" "backup_file" ( load_on_startup ) Restores and loads a wallet from backup. The rescan is significantly faster if a descriptor wallet is restored and block filters are available (using startup option "-blockfilterindex=1"). Arguments: 1. wallet_name (string, required) The name that will be applied to the restored wallet 2. backup_file (string, required) The backup file that will be used to restore the wallet. 3. load_on_startup (boolean, optional) Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged. Result: { (json object) "name" : "str", (string) The wallet name if restored successfully. "warnings" : [ (json array, optional) Warning messages, if any, related to restoring and loading the wallet. "str", (string) ... ] } Examples: > bitcoin-cli restorewallet "testwallet" "home\backups\backup-file.bak" > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "restorewallet", "params": ["testwallet" "home\backups\backup-file.bak"]}' -H 'content-type: application/json' http://127.0.0.1:8332/ > bitcoin-cli -named restorewallet wallet_name=testwallet backup_file='home\backups\backup-file.bak"' load_on_startup=true > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "restorewallet", "params": {"wallet_name":"testwallet","backup_file":"home\\backups\\backup-file.bak\"","load_on_startup":true}}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

restorewallet(wallet_name: string, backup_file: string, load_on_startup?: boolean) → any

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"restorewallet","params":["\"<wallet_name>\"","\"<backup_file>\"",false]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli restorewallet "testwallet" "home\backups\backup-file.bak"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "restorewallet", "params": ["testwallet" "home\backups\backup-file.bak"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

bitcoin-cli -named restorewallet wallet_name=testwallet backup_file='home\backups\backup-file.bak"' load_on_startup=true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "restorewallet", "params": {"wallet_name":"testwallet","backup_file":"home\\backups\\backup-file.bak\"","load_on_startup":true}}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "restorewallet",
        "params": ["\"<wallet_name>\"", "\"<backup_file>\"", false],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "restorewallet",
    params: ["\"<wallet_name>\"","\"<backup_file>\"",false],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
wallet_name	`string`	yes	The name that will be applied to the restored wallet
backup_file	`string`	yes	The backup file that will be used to restore the wallet.
load_on_startup	`boolean`	—	Save wallet name to persistent settings and load on startup. True to add wallet to startup list, false to remove, null to leave unchanged.

Result

Type: any

{ (json object) "name" : "str", (string) The wallet name if restored successfully. "warnings" : [ (json array, optional) Warning messages, if any, related to restoring and loading the wallet. "str", (string) ... ] }

Source: services/core-node/bcore/src/wallet/rpc/backup.cpp:609

C++ symbol: restorewallet

Code samples

curl --user "$RPC_USER:$RPC_PASS" \
  --data-binary '{"jsonrpc":"1.0","id":"docs","method":"restorewallet","params":["\"<wallet_name>\"","\"<backup_file>\"",false]}' \
  -H 'content-type: text/plain;' \
  http://127.0.0.1:8332/

bitcoin-cli restorewallet "testwallet" "home\backups\backup-file.bak"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "restorewallet", "params": ["testwallet" "home\backups\backup-file.bak"]}' -H 'content-type: application/json' http://127.0.0.1:8332/

bitcoin-cli -named restorewallet wallet_name=testwallet backup_file='home\backups\backup-file.bak"' load_on_startup=true

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "restorewallet", "params": {"wallet_name":"testwallet","backup_file":"home\\backups\\backup-file.bak\"","load_on_startup":true}}' -H 'content-type: application/json' http://127.0.0.1:8332/

import requests
r = requests.post(
    "http://127.0.0.1:8332/",
    auth=("$RPC_USER", "$RPC_PASS"),
    json={
        "jsonrpc": "1.0",
        "id": "docs",
        "method": "restorewallet",
        "params": ["\"<wallet_name>\"", "\"<backup_file>\"", false],
    },
    timeout=30,
)
print(r.json())

const res = await fetch("http://127.0.0.1:8332/", {
  method: "POST",
  headers: {
    "content-type": "application/json",
    "authorization": "Basic " + btoa(`${process.env.RPC_USER}:${process.env.RPC_PASS}`),
  },
  body: JSON.stringify({
    jsonrpc: "1.0",
    id: "docs",
    method: "restorewallet",
    params: ["\"<wallet_name>\"","\"<backup_file>\"",false],
  }),
});
console.log(await res.json());