set_bans - Monero

Example code for the set_bans JSON-RPC method. Complete guide on how to use set_bans JSON-RPC in GetBlock Web3 documentation.

This method adds or removes bans on one or more IP addresses. Administrative operation.

Parameters

Parameter

Type

Required

Description

bans

array

Yes

Array of ban objects to apply

bans[].host

string

Yes

IP address or hostname to ban

bans[].ban

boolean

Yes

true to ban, false to unban

bans[].seconds

unsigned int

Yes

Duration of the ban in seconds

Request Example

curl --location --request POST 'https://go.getblock.io/<ACCESS-TOKEN>/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "2.0",
    "method": "set_bans",
    "params": {
        "bans": [
            {
                "host": "192.0.2.1",
                "ban": true,
                "seconds": 30
            }
        ]
    },
    "id": "getblock.io"
}'

import axios from 'axios';

const data = JSON.stringify({
    "jsonrpc": "2.0",
    "method": "set_bans",
    "params": {
        "bans": [
            {
                "host": "192.0.2.1",
                "ban": true,
                "seconds": 30
            }
        ]
    },
    "id": "getblock.io"
});

const config = {
    method: 'post',
    url: 'https://go.getblock.io/<ACCESS-TOKEN>/',
    headers: {
        'Content-Type': 'application/json'
    },
    data: data
};

axios(config)
    .then(response => console.log(JSON.stringify(response.data, null, 2)))
    .catch(error => console.log(error));

import requests
import json

url = "https://go.getblock.io/<ACCESS-TOKEN>/"

payload = json.dumps({
    "jsonrpc": "2.0",
    "method": "set_bans",
    "params": {
        "bans": [
            {
                "host": "192.0.2.1",
                "ban": true,
                "seconds": 30
            }
        ]
    },
    "id": "getblock.io"
})

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers, data=payload)
print(response.text)

use reqwest::Client;
use serde_json::json;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let payload = json!({
        "jsonrpc": "2.0",
        "method": "set_bans",
        "params": {
                "bans": [
                        {
                                "host": "192.0.2.1",
                                "ban": true,
                                "seconds": 30
                        }
                ]
        },
        "id": "getblock.io"
});

    let response = client
        .post("https://go.getblock.io/<ACCESS-TOKEN>/")
        .header("Content-Type", "application/json")
        .json(&payload)
        .send()
        .await?;

    let result: serde_json::Value = response.json().await?;
    println!("{:#?}", result);

    Ok(())
}

Response Example

{
    "id": "getblock.io",
    "jsonrpc": "2.0",
    "result": {
        "status": "OK"
    }
}

Response Parameters

Field

Type

Description

result.status

string

OK if the bans were applied

Use Cases

Manually banning misbehaving peers on a dedicated node
Implementing custom peer-management policies

Error Handling

Status Code

Error Message

Cause

404

Not Found

Missing or invalid <ACCESS-TOKEN>

-32602

Invalid params

Request parameters are missing or malformed

429

Too Many Requests

Rate limit exceeded for your plan

Previoussend_raw_transaction - Monero Nextsubmit_block - Monero

Last updated 13 days ago

Was this helpful?