Create global exclusion

POST

/api/admin/exclusions

curl --request POST \
  --url https://hitkeep.com/api/admin/exclusions \
  --header 'Content-Type: application/json' \
  --cookie hk_token=<hk_token> \
  --data '{ "cidr": "example", "description": "example" }'

Creates instance-level IP/CIDR exclusion for all sites. Requires instance.manage_site_exclusions.

Authorizations

• cookieAuth

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

<= 255 characters

Example ^generated

{
  "cidr": "example",
  "description": "example"
}

Responses

201

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"
}

400

Invalid IP/CIDR

Media type application/json

object

message

string

Example ^generated

{
  "message": "example"
}