Skip to main content
GET
Retrieve policy overrides

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

Query Parameters

ordering
enum<string> | null

Determine the field used to order results.

Available options:
id,
name,
target_type,
enabled,
stale,
created_at,
updated_at,
-id,
-name,
-target_type,
-enabled,
-stale,
-created_at,
-updated_at
limit
integer
default:100

Number of items to return

Required range: 0 <= x <= 100
offset
integer
default:0

Number of items to skip

Required range: 0 <= x <= 100000
target_type
enum<string> | null

Filter by linked target type.

Available options:
detector,
rule
enabled
boolean | null

Filter by enabled state.

search
string | null

Search policy override names and descriptions.

Minimum string length: 1

Response

Successful Response

limit
integer
required

Number of items requested in the response

offset
integer
required

Items response offset used

count
integer
required

Number of items contain in the response

results
PolicyOverrideResponse · object[]
required

List of items returned in the response following given criteria