Client — Firewall

Updated Oct 4, 2026 Markdown

`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):

JSON

{
  "data": [
    {}
  ],
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

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:

JSON

{
  "comment": "string",
  "ip": "string"
}

Responses:

Status	Schema	Description
`200`	`ApiSuccess_dict_str__Any__`	Successful Response
`422`	`HTTPValidationError`	Validation Error

Response example (200):

JSON

{
  "data": {},
  "message": "",
  "status": "success",
  "warnings": [
    "string"
  ]
}

cURL example:

shell

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):

JSON

{
  "message": "string",
  "status": "success"
}

cURL example:

shell

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}

Still Need Help?

Our support team is here around the clock for anything you can't find above.