setban

setban "subnet" "command" ( bantime absolute ) Attempts to add or remove an IP/Subnet from the banned list. Arguments: 1. subnet (string, required) The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP) 2. command (string, required) 'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list 3. bantime (numeric, optional, default=0) time in seconds how long (or until when if [absolute] is set) the IP is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument) 4. absolute (boolean, optional, default=false) If set, the bantime must be an absolute timestamp expressed in UNIX epoch time Result: null (json null) Examples: > bitcoin-cli setban "192.168.0.6" "add" 86400 > bitcoin-cli setban "192.168.0.0/24" "add" > curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "setban", "params": ["192.168.0.6", "add", 86400]}' -H 'content-type: application/json' http://127.0.0.1:8332/

Signature

setban(subnet: string, command: string, bantime?: number, absolute?: boolean) → any

Code samples

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

bitcoin-cli setban "192.168.0.6" "add" 86400

bitcoin-cli setban "192.168.0.0/24" "add"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "setban", "params": ["192.168.0.6", "add", 86400]}' -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": "setban",
        "params": ["\"<subnet>\"", "\"<command>\"", 0, 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: "setban",
    params: ["\"<subnet>\"","\"<command>\"",0,false],
  }),
});
console.log(await res.json());

Parameters

Name	Type	Req.	Description
subnet	`string`	yes	The IP/Subnet (see getpeerinfo for nodes IP) with an optional netmask (default is /32 = single IP)
command	`string`	yes	'add' to add an IP/Subnet to the list, 'remove' to remove an IP/Subnet from the list
bantime	`number`	—	time in seconds how long (or until when if [absolute] is set) the IP is banned (0 or empty means using the default time of 24h which can also be overwritten by the -bantime startup argument)
absolute	`boolean`	—	If set, the bantime must be an absolute timestamp expressed in UNIX epoch time

Result

Type: any

null (json null)

Source: services/core-node/bcore/src/rpc/net.cpp:725

C++ symbol: setban

Code samples

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

bitcoin-cli setban "192.168.0.6" "add" 86400

bitcoin-cli setban "192.168.0.0/24" "add"

curl --user myusername --data-binary '{"jsonrpc": "2.0", "id": "curltest", "method": "setban", "params": ["192.168.0.6", "add", 86400]}' -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": "setban",
        "params": ["\"<subnet>\"", "\"<command>\"", 0, 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: "setban",
    params: ["\"<subnet>\"","\"<command>\"",0,false],
  }),
});
console.log(await res.json());