Sites

Create site exclusion

Creates a forward-only CIDR, country, user-agent, or path exclusion for this site. Requires site data-control permission or the narrow instance site-exclusion permission.

post/api/sites/{id}/exclusions

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/sites/{id}/exclusions
  • Auth: API key in cookie hk_token

Path parameters

idstring uuid required

Request body

cidrstring

IP or CIDR value for cidr rules. Plain IP values are normalized to /32 (IPv4) or /128 (IPv6).

country_codestring

ISO 3166-1 alpha-2 country code for country rules. Values are normalized to uppercase.

descriptionstring
pathstring

Path rule. Query and fragment are removed; duplicate or trailing slashes and dot segments are normalized before case-sensitive segment-boundary matching.

type'cidr' | 'country' | 'user_agent' | 'path'

Rule type. Omitted cidr requests remain accepted for backward compatibility.

user_agentstring

Case-insensitive substring for user_agent rules. Leading and trailing whitespace is removed.

Response

Created exclusion

cidrstring

Normalized IP or CIDR value for cidr rules.

country_codestring

Uppercase ISO 3166-1 alpha-2 country code for country rules.

created_atstring date-time required
created_bystring uuid

Creator ID. Omitted from inherited rows returned across scopes.

descriptionstring
idstring uuid required
inheritedboolean required

True when returned through a child scope's effective read.

pathstring

Normalized, query-free, case-sensitive path matched on segment boundaries.

scope'instance' | 'team' | 'site'

Scope that owns this rule.

site_idstring uuid

Owning site for site rules.

team_idstring uuid

Owning team for team rules.

type'cidr' | 'country' | 'user_agent' | 'path' required
user_agentstring

Case-insensitive user-agent substring for user_agent rules.

Changes

No recorded changes to this operation across all 1 revision of this API.