List team traffic exclusions REST API

GET

/api/user/teams/{id}/exclusions

curl --request GET \
  --url 'http://127.0.0.1:25737/api/user/teams/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/exclusions?effective=false' \
  --cookie hk_token=<hk_token>

Lists traffic exclusions owned by the team. Set effective=true to include inherited instance rules before team rules, newest-first within each scope. Inherited rows are read-only and omit cross-scope creator IDs. Requires team.manage_settings.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Query Parameters

effective

boolean

Include inherited instance rules.

Responses

200

Team traffic exclusions

Media typeapplication/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

id

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

403

Access denied

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}