Block IP addresses - NetSapiens API v2

Blocks addresses at the firewall on one server, so every packet from them is dropped until the block expires. The other servers in the cluster receive the block shortly after. Requires Super User scope.

Send the address in the body, or in the ip query parameter. Only single IPv4 or IPv6 addresses can be blocked, not ranges. Send an array, or repeat the query parameter, to block several in one call; the answer reports each one, with 207 when any failed. An address on the allow list, on the never-block list, or belonging to the platform is not blocked and answers skipped. Blocking by hand must be allowed on the server (firewall_manual_enable), or the answer is 400. To keep an address from ever being blocked, add it with POST /ipaware/{hostname}/allowed_ips instead.

The request goes to the IP rules service on {hostname}, and its status and body come back unchanged. Errors the API decides itself use the code and message form; errors from the service use the error form.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200OK

application/json

Every address was processed. Check status: an address can be skipped or a duplicate rather than blocked.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests

🔴500Internal Server Error

🟠404Not Found

🟢207Multi-Status

🔴503Service Unavailable

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/ipaware//firewall/block?ip=203.0.113.9&reason=Fraud%20investigation' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "ip": "203.0.113.9", "reason": "Fraud investigation", "ttl": 86400 }'