Create site exclusion
POST
/api/sites/{id}/exclusions
const url = 'https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/exclusions';const options = { method: 'POST', headers: {cookie: 'hk_token=<hk_token>', 'Content-Type': 'application/json'}, body: '{"cidr":"example","description":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://hitkeep.com/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/exclusions \ --header 'Content-Type: application/json' \ --cookie hk_token=<hk_token> \ --data '{ "cidr": "example", "description": "example" }'Creates per-site IP/CIDR exclusion rule. Requires site data-control permission or the narrow instance site-exclusion permission.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string format: uuid
Request Body required
Section titled “Request Body required ” Media type application/json
object
cidr
required
IP or CIDR value. Plain IP values are normalized to /32 (IPv4) or /128 (IPv6).
string
description
string
Example generated
{ "cidr": "example", "description": "example"}Responses
Section titled “ Responses ”Created exclusion
Media type application/json
object
cidr
string
created_at
string format: date-time
created_by
string format: uuid
description
string
id
string format: uuid
site_id
string format: uuid
Example generated
{ "cidr": "example", "created_at": "2026-04-15T12:00:00Z", "created_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "description": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "site_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Invalid IP/CIDR
Media type application/json
object
message
string
Example generated
{ "message": "example"}