Skip to main content
PATCH
Update a policy override

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

domain_id
integer
required

The domain ID

policy_override_id
integer
required

Policy override ID

Body

application/json
name
string | null

The policy override's display name

Required string length: 1 - 100
description
string | null

An optional note explaining the override

Maximum string length: 1000
conditions
PolicyOverrideCondition · object[] | null

The conditions required for the override to apply. An override may have up to 5 conditions; all must pass for the override to apply. Without conditions the override applies to every request on the owning domain that hits a linked target.

Maximum array length: 5
enabled
boolean | null

Whether the override is active

Response

Successful Response

id
integer
required

The policy override's ID

domain_id
integer
required

The domain this override belongs to

name
string
required

The policy override's display name

target_type
enum<string>
required

Whether targets are detectors or rules

Available options:
detector,
rule
targets
PolicyOverrideTarget · object[]
required

The detectors or rules this override suppresses

conditions
PolicyOverrideCondition · object[]
required

The conditions required for the override to apply. Empty means the override applies to every request on the owning domain that hits a linked target.

enabled
boolean
required

Whether the override is active

stale
boolean
required

Whether a linked target has been deleted, disabled, or otherwise become invalid. A stale override is not published and does not suppress anything until it's edited.

created_at
string<date-time>
required

When the override was created

updated_at
string<date-time>
required

When the override was last updated

description
string | null

An optional note explaining the override