List global exclusions REST API

GET

/api/admin/exclusions

const url = 'http://127.0.0.1:25737/api/admin/exclusions';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://127.0.0.1:25737/api/admin/exclusions \
  --cookie hk_token=<hk_token>

Lists instance-level CIDR, country, user-agent, and path exclusions used by forward-only ingest-time filtering. Requires instance.manage_site_exclusions.

Authorizations

cookieAuth

Responses

200

Global exclusions

application/json

Array<object>

object

cidr

Normalized IP or CIDR value for cidr rules.

string

country_code

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

string

created_at

required

string format: date-time

created_by

Creator ID. Omitted from inherited rows returned across scopes.

string format: uuid

description

string

required

string format: uuid

inherited

required

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

boolean

path

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

string

scope

Scope that owns this rule.

string

Allowed values: instance team site

site_id

Owning site for site rules.

string format: uuid

team_id

Owning team for team rules.

string format: uuid

type

required

string

Allowed values: cidr country user_agent path

user_agent

Case-insensitive user-agent substring for user_agent rules.

string

Example

[
  {
    "scope": "instance",
    "type": "cidr"
  }
]