Unban Pubkeys
API-v1unban_pubkeys
The unban_pubkeys method will remove all currently banned pubkeys from your ban list, or specific pubkeys from a user-defined list.
Use the secp256k1 pubkey without prefix for this method input. For example, if the pubkey is 022cd3021a2197361fb70b862c412bc8e44cff6951fa1de45ceabfdd9b4c520420, you should submit 2cd3021a2197361fb70b862c412bc8e44cff6951fa1de45ceabfdd9b4c520420.
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| pubkey | string | ✓ | - | The pubkey to ban |
| unban_by.data | list | ✗ | - | A list of pubkeys to unban. Only required when type is Few. |
| unban_by.type | string | ✓ | - | A standard UnbanTypeEnum enum. Whether to unban all pubkeys or specific ones from a list |
| Parameter | Type | Description |
|---|---|---|
| still_banned | list | List of pubkeys which remain banned. For each pubkey, the reason it was banned (pubkey.reason) and the type of ban (pubkey.type) is also returned. |
| unbanned | list | List of pubkeys which were unbanned. For each pubkey, the reason it was banned (pubkey.reason) and the type of ban (pubkey.type) is also returned. |
| were_not_banned | list | If using unban_by.type: Few, this will return a list of pubkeys which were not banned, but had been requested to be unbanned. |
unban_pubkeys
POST
unban_pubkeys{
"userpass": "RPC_UserP@SSW0RD",
"method": "unban_pubkeys",
"unban_by": {
"type": "All"
}
}
unban_pubkeys
POST
unban_pubkeys{
"userpass": "RPC_UserP@SSW0RD",
"method": "unban_pubkeys",
"unban_by": {
"type": "Few"
},
"data": [
"2cd3021a2197361fb70b862c412bc8e44cff6951fa1de45ceabfdd9b4c520420",
"2cd3021a2197361fb70b862c412bc8e44cff6951fa1de45ceabfdd9b4c520422"
]
}