Skip to main content
GET
Retrieve a Site's Security Configuration

Authorizations

Authorization
string
header
required

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

Path Parameters

siteId
string<uuid>
required

The unique identifier of the site.

Response

The site's security configuration.

id
string<uuid>

The unique identifier of the site.

Example:

"9a9d3e6a-5c3a-4f1e-9a0a-2b2a1e1d8e8d"

ip_address
string<ipv4>

The management IP address of the site's tunnel.

Example:

"100.64.10.5"

policy_id
string<uuid> | null

The ID of the DNS policy attached to this site, if any.

policy_name
string | null

The name of the attached DNS policy.

dnr_policy_id
string<uuid> | null

The ID of the BGP policy attached to this site, if any.

dnr_policy_name
string | null

The name of the attached BGP policy.

dns_online
boolean

The operational status of the DNS filtering service for this site.

dnr_online
boolean

The operational status of the BGP filtering service for this site.