Skip to main content
PUT
Update a DNS Policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

policyId
string<uuid>
required

The unique identifier of the DNS policy to update.

Body

application/json
name
string
required

A human-readable name for the policy.

Example:

"Guest Wi-Fi Policy"

block_adult
boolean
required

If true, automatically blocks all applications categorized as adult content.

Example:

true

applications
string<uuid>[]

A list of application IDs to be blocked by this policy.

Example:

A list of Safe Search enforcement rules.

dns_whitelist
string<hostname>[]

A list of FQDNs to always allow.

Example:
dns_blacklist
string<hostname>[]

A list of FQDNs to always block.

sites
string<uuid>[]

A list of site IDs to which this policy should be attached. Any sites not in this list will be detached.

Example:

Response

The DNS policy was updated successfully.

id
string<uuid>
read-only

The unique identifier for the DNS policy.

Example:

"9a9a3e6a-5c3a-4f1e-9a0a-2b2a1e1d8e8a"

name
string

A human-readable name for the policy.

Example:

"Standard Employee Policy"

applications
string<uuid>[]

A list of application IDs to be blocked by this policy.

Example:

A list of Safe Search enforcement rules.

dns_whitelist
string<hostname>[]

A list of fully qualified domain names (FQDNs) to always allow, overriding any blocking rules.

Example:
dns_blacklist
string<hostname>[]

A list of fully qualified domain names (FQDNs) to always block.

Example:
block_adult
boolean

If true, automatically blocks all applications categorized as adult content.

Example:

true

attachments
integer
read-only

The number of sites currently using this policy.

Example:

5

created_at
string<date-time>
read-only

The timestamp when the policy was created.

Example:

"2025-10-29T13:04:44Z"