Skip to main content

DnsRule Schema

Data structure for Dns Rule objects.

Fields​

FieldTypeRequiredDescriptionNotes
access_controlstringNo-API field: access_control
actionstringNo--
block_response_codestringNo-API field: block_response_code
default_rulebooleanNo-API field: default_rule
departmentsEntityReferenceWrapperCollectionNo--
descriptionstringNo--
dest_addressesstringCollectionNo-API field: dest_addresses
dest_countriesDestCountriesEnumCollectionNo-API field: dest_countries
dest_ip_categoriesstringCollectionNo-API field: dest_ip_categories
dest_ip_groupsEntityReferenceWrapperCollectionNo-API field: dest_ip_groups
dest_ipv6_groupsEntityReferenceWrapperCollectionNo-API field: dest_ipv6_groups
device_groupsEntityReferenceWrapperCollectionNo-API field: device_groups
devicesEntityReferenceWrapperCollectionNo--
dns_gatewayEntityReferenceNo-API field: dns_gateway
ec_groupsEntityReferenceWrapperCollectionNo-API field: ec_groups
end_point_application_groupsEndPointApplicationGroupWrapperCollectionNo-API field: end_point_application_groups
end_point_application_threat_levelsEndPointApplicationThreatLevelsEnumCollectionNo-API field: end_point_application_threat_levels
end_point_applicationsEndPointApplicationLiteWrapperCollectionNo-API field: end_point_applications
exclude_context_shield_end_pointbooleanNo-API field: exclude_context_shield_end_point
groupsEntityReferenceWrapperCollectionNo--
idintegerYes--
labelsEntityReferenceWrapperCollectionNo--
last_modified_byEntityReferenceNo-API field: last_modified_by
last_modified_timeintegerNo-API field: last_modified_time
location_groupsEntityReferenceWrapperCollectionNo-API field: location_groups
locationsEntityReferenceWrapperCollectionNo--
namestringYes--
orderintegerNo--
predefinedbooleanNo--
rankintegerNo--
redirect_ipstringNo-API field: redirect_ip
res_categoriesstringCollectionNo-API field: res_categories
source_countriesDestCountriesEnumCollectionNo-API field: source_countries
source_ip_group_exclusionbooleanNo-API field: source_ip_group_exclusion
source_ip_group_exclusion_flagbooleanNo-API field: source_ip_group_exclusion_flag
src_ip_groupsEntityReferenceWrapperCollectionNo-API field: src_ip_groups
src_ipsstringCollectionNo-API field: src_ips
src_ipv6_groupsEntityReferenceWrapperCollectionNo-API field: src_ipv6_groups
statestringNo--
template_synced_rule_flagstringNo-API field: template_synced_rule_flag
time_windowsEntityReferenceWrapperCollectionNo-API field: time_windows
usersEntityReferenceWrapperCollectionNo--
zpa_ip_groupEntityReferenceNo-API field: zpa_ip_group

Example​

{
"access_control": "string",
"action": "string",
"block_response_code": "string",
"default_rule": true,
"departments": [
{
"association_time": 123,
"deleted": true,
"extensions": {
"id": "object-id"
}
}
],
"description": "string",
"dest_addresses": [
"value"
],
"dest_countries": [
"value"
]
}
// ... more fields