curl --request POST \
--url http://localhost:8080/blocklist/ips \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ips": "<string>",
"reason": "<string>",
"expires_in_hours": 123
}
'import requests
url = "http://localhost:8080/blocklist/ips"
payload = {
"ips": "<string>",
"reason": "<string>",
"expires_in_hours": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({ips: '<string>', reason: '<string>', expires_in_hours: 123})
};
fetch('http://localhost:8080/blocklist/ips', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/blocklist/ips",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ips' => '<string>',
'reason' => '<string>',
'expires_in_hours' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/blocklist/ips"
payload := strings.NewReader("{\n \"ips\": \"<string>\",\n \"reason\": \"<string>\",\n \"expires_in_hours\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/blocklist/ips")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ips\": \"<string>\",\n \"reason\": \"<string>\",\n \"expires_in_hours\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/blocklist/ips")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ips\": \"<string>\",\n \"reason\": \"<string>\",\n \"expires_in_hours\": 123\n}"
response = http.request(request)
puts response.read_body{
"blocked": [
{
"id": "<string>",
"ip_address": "<string>",
"reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
],
"skipped": [
"<string>"
],
"failed": [
{
"ip": "<string>",
"error": "<string>"
}
],
"summary": {
"total": 123,
"blocked": 123,
"skipped": 123,
"failed": 123
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Block IP addresses
Block IP addresses or CIDR ranges, IPv4 or IPv6, optionally with expires_in_hours. Applies to web widget traffic — email and WhatsApp carry no visitor IP.
curl --request POST \
--url http://localhost:8080/blocklist/ips \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ips": "<string>",
"reason": "<string>",
"expires_in_hours": 123
}
'import requests
url = "http://localhost:8080/blocklist/ips"
payload = {
"ips": "<string>",
"reason": "<string>",
"expires_in_hours": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({ips: '<string>', reason: '<string>', expires_in_hours: 123})
};
fetch('http://localhost:8080/blocklist/ips', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "8080",
CURLOPT_URL => "http://localhost:8080/blocklist/ips",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'ips' => '<string>',
'reason' => '<string>',
'expires_in_hours' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:8080/blocklist/ips"
payload := strings.NewReader("{\n \"ips\": \"<string>\",\n \"reason\": \"<string>\",\n \"expires_in_hours\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:8080/blocklist/ips")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ips\": \"<string>\",\n \"reason\": \"<string>\",\n \"expires_in_hours\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:8080/blocklist/ips")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ips\": \"<string>\",\n \"reason\": \"<string>\",\n \"expires_in_hours\": 123\n}"
response = http.request(request)
puts response.read_body{
"blocked": [
{
"id": "<string>",
"ip_address": "<string>",
"reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z"
}
],
"skipped": [
"<string>"
],
"failed": [
{
"ip": "<string>",
"error": "<string>"
}
],
"summary": {
"total": 123,
"blocked": 123,
"skipped": 123,
"failed": 123
}
}{
"statusCode": 123,
"message": "<string>",
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
IP(s) or CIDR range(s) to block — comma-separated for multiple (e.g. "203.0.113.7, 198.51.100.0/24")
1Why these addresses are being blocked
Lift the block automatically after this many hours (max 8760). Omit for a permanent block. Automated callers should always set this: a shared or carrier-grade NAT address fronts many people, and a permanent block on one bans all of them.
x <= 8760Response
Default Response
Addresses that were successfully blocked
Show child attributes
Show child attributes
Addresses that needed no action — already blocked, or not a valid IP/CIDR
Addresses that could NOT be blocked — these are still unblocked
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?