Client — Firewall
GET /api/v1/client/firewall/blocked-ips
List blocked IPs (client)
Firewall management is server-level; this answers 403 FEATURE_UNAVAILABLE like the client write endpoints.
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_list_dict_str__Any___ |
Successful Response |
Response example (200):
{
"data": [
{}
],
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/client/firewall/blocked-ips
POST /api/v1/client/firewall/blocked-ips
Block IP (client)
Firewall management is server-level; answers 403 FEATURE_UNAVAILABLE for an authenticated tenant.
Body fields:
| Field | Type | Required | Notes |
|---|---|---|---|
comment |
string | no | — |
ip |
string | yes | IP address or CIDR block to block |
Request body example:
{
"comment": "string",
"ip": "string"
}
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_dict_str__Any__ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
-H "Content-Type: application/json" \
-d @body.json \
https://your-server:2000/api/v1/client/firewall/blocked-ips
DELETE /api/v1/client/firewall/blocked-ips/{ip}
Unblock IP (client)
Firewall management is server-level; answers 403 FEATURE_UNAVAILABLE for an authenticated tenant.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
ip |
string | yes | — |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
MessageResponse |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"message": "string",
"status": "success"
}
cURL example:
curl -X DELETE \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/client/firewall/blocked-ips/{ip}
GET /api/v1/client/firewall/ip-blocks
List addresses blocked on my sites (client)
The signed-in account's own block list. The block is written into every vhost of the account (nginx deny; Apache Require not ip when Apache faces visitors itself): it refuses the address on this account's sites only and never touches the server firewall. The address is the visitor's as the web server sees it (behind Cloudflare, the real visitor address).
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_list_AccountIPBlockResponse__ |
Successful Response |
Response example (200):
{
"data": [
{
"comment": "...",
"created_at": "...",
"id": "...",
"ip": "..."
}
],
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X GET \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/client/firewall/ip-blocks
POST /api/v1/client/firewall/ip-blocks
Block an address on my sites (client)
Adds one address or network (IPv4 up to /16, IPv6 up to /48) to the signed-in account's block list. The block is written into every vhost of the account (nginx deny; Apache Require not ip when Apache faces visitors itself): it refuses the address on this account's sites only and never touches the server firewall. The address is the visitor's as the web server sees it (behind Cloudflare, the real visitor address). An address already on the list answers 200 unchanged; at most 500 entries (422).
Body fields:
| Field | Type | Required | Notes |
|---|---|---|---|
comment |
string | no | — |
ip |
string | yes | IP address or CIDR block to block |
Request body example:
{
"comment": "string",
"ip": "string"
}
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
ApiSuccess_AccountIPBlockResponse_ |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"data": {
"comment": "...",
"created_at": "...",
"id": "string",
"ip": "string"
},
"message": "",
"status": "success",
"warnings": [
"string"
]
}
cURL example:
curl -X POST \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
-H "Content-Type: application/json" \
-d @body.json \
https://your-server:2000/api/v1/client/firewall/ip-blocks
DELETE /api/v1/client/firewall/ip-blocks/{ip}
Unblock an address on my sites (client)
Removes the entry (ip URL-encoded). An address that is not on the account's list answers 404 NOT_FOUND.
Path parameters:
| Name | Type | Required | Notes |
|---|---|---|---|
ip |
string | yes | — |
Responses:
| Status | Schema | Description |
|---|---|---|
200 |
MessageResponse |
Successful Response |
422 |
HTTPValidationError |
Validation Error |
Response example (200):
{
"message": "string",
"status": "success"
}
cURL example:
curl -X DELETE \
-H "X-WHost-Key: $WHOST_API_KEY" \
-H "X-WHost-Timestamp: $(date +%s)" \
-H "X-WHost-Nonce: $(openssl rand -hex 16)" \
-H "X-WHost-Signature: $(compute_hmac)" \
https://your-server:2000/api/v1/client/firewall/ip-blocks/{ip}
Our support team is here around the clock for anything you can't find above.