Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create block rules to prevent researchers from sending requests to specific paths or using certain HTTP methods on your HackGATE test environment.
| Field | Type | Required | Description |
|---|---|---|---|
pathPrefix | string | Yes | URL path prefix the rule applies to. Must start with /. |
methods | string[] | No | HTTP methods to match. Use ["*"] to match all methods. Defaults to ["*"]. |
status | integer | Yes | HTTP status code to return when the rule matches (100–599). |
enabled | boolean | No | Whether the rule is active. Defaults to true. |
curl https://api-admin.hackgate.io/api/sites/SITE_ID/blocklist \
-H "Authorization: Bearer <token>"
{"blockListJson": "[{...}]"}
blockListJson value is a JSON-encoded string containing the array of block rules.
POST /api/sites/blocklist endpoint replaces the entire block rule list for a site. Construct your full desired list and submit it as a JSON-encoded string in the blockListJson field.
curl -X POST https://api-admin.hackgate.io/api/sites/blocklist \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"siteId": "SITE_ID",
"blockListJson": "[{\"pathPrefix\":\"/admin\",\"methods\":[\"*\"],\"status\":403,\"enabled\":true},{\"pathPrefix\":\"/internal\",\"methods\":[\"POST\",\"PUT\",\"DELETE\"],\"status\":403,\"enabled\":true}]"
}'
blockListJson to an empty array:
curl -X POST https://api-admin.hackgate.io/api/sites/blocklist \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"siteId": "SITE_ID", "blockListJson": "[]"}'
"enabled": true are enforced — you can disable a rule without removing it by setting "enabled": false.
POST endpoint replaces all existing rules. Fetch the current list first if you want to add a rule without removing the ones already in place.Was this page helpful?