Delete DNS Service Profile (v2.0)
Delete an existing DNS service profile.
Path Parameters
- dnsservice_role_id string required
ID of the DNS service profile.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
authoritative_config AuthoritativeConfig
The configuration details of the authoritative DNS server where all the queries will try to resolve without forwarding it to external servers.
caa_records CaaRecord[]
List of valid CAA records. CAA record is a type of DNS record used to provide additional confirmation for the Certification Authority (CA) when validating an SSL certificate.
Array [flags string requiredThe CAA record flags.
name string requiredThe CAA record name. Max size = 128.
tag string requiredAn information field that can be added to identify the CCA record.
value string requiredThe value of the CAA record. Max size = 256.
]cname_records CnameRecords[]
List of valid cname records.
Array [name string[] requiredThe unique name of the CAA record.
target string requiredThe CAA name record traget. Max size = 128.
ttl integerThe TTL range of the CAA record.
]dns_resource_records DnsResourceRecords[]
The list of valid DNS resource records.
Array [hex_data stringThe value of the DNS record is given by the hex data. Max size = 128.
name string requiredThe unique name of the DNS resource record. Max size = 128.
rr_number integer requiredThe DNS resource record number.
]host_records HostRecord[]
The list of valid DNS host records.
Array [domain_names string[] requiredThe list of configured host record domain names.
ipv4_address stringThe IPv4 address for the host.
ipv6_address stringThe IPv6 address for the host.
ttl integerThe ttl range of the host record.
]mx_host_records MxHostRecord[]
The details of the MX host records.
Array [hostname string requiredThe MX host name. Max size = 128.
mx_name string requiredThe MX name. Max size = 128.
preference int32The preference of the MX host record.
]naptr_records NaptrRecords[]
The details of the naptr records.
Array [flags string requiredThe naptr record flags.
name string requiredThe naptr record name.
order integer requiredThe valid order of the naptr record.
preference integer requiredThe valid naptr prefernce range.
regexp stringThe regexp to match DNS host name or IP address. Max size = 256.
replacement stringThe valid replacement value of the naptr record. Max size = 256.
service stringThe service value of the naptr record. Max size = 256.
]peers string[]List of the valid IP addresses of the DNS service profiles.
ptr_records PtrRecords[]
The details of the DNS PTR records. DNS PTR record is used for reverse DNS lookups, and it matches domain names with IP addresses.
Array [name string requiredThe name of the DNS ptr record. Max size = 128.
target stringThe ptr record target value. Max size = 256.
]secondary_servers string[]he secondary server details of the DNS profile.
servers Server[]
The DNS profile server details.
Array [dnsservicerole_id stringThe ID of the DNS service role.
domain_name string requiredThe domain name of the auth servers.
]soa SOA[]
The start of authority (SOA) record which includes administrative information on the zone, as defined by the domain name system (DNS).
Array [expiry integerThe expiry range.
host_master stringHost Master
refresh integerThe refresh value.
retry integerThe retry value.
serial_number integer requiredThe SOA auth config serial number.
]srv_hosts SrvHost[]
The SRV record specifies a host and port for specific services. It includes a port alongwith the IP address.
Array [domain_name stringThe SRV host domain name.
port integerThe SRV host port.
priority integerThe SRV host priority.
protocol string requiredThe SRV host protocol.
service string requiredThe SRV host service.
target integerThe SRV host target.
weight integerThe SRV host weight.
]synth_domains SynthDomain[]
Lists the details of the DNS syth domains.
Array [domain string requiredThe synth domain name.
end_ipaddress stringThe synth domain end IP address.
ipaddress_prefix stringThe synth domain IP address prefix.
prefix stringThe synth domain prefex.
start_ipaddress stringThe synth doamin start IP address.
]ttl integerThe ttl range.
txt_records TxtRecord[]
Lists the details of DNS TXT records.
Array [domain_name string requiredThe TXT record domain name. Max size = 128.
texts string[]The text length of the TXT record.
]zones Zone[]
List the details of the authoritative zones.
Array [domain_name string requiredThe authoritative config zone domain name.
exclude_prefix string[]The exclude prefix of the authoritative config domain.
include_prefix string[]The inlcude prefix of the authoritative config domain.
]cache_config CacheConfig
Lists details of the cache configuration.
cache_size int32The cache size.
disable_negative_caching booleanIf the option disable negative caching option is disabled.
max_cache_ttl integerThe max cache ttl range.
min_cache_ttl int32The min cacahe ttl range.
negative_cache_ttl integerThe negative cache ttl range.
- description
The description of the DNS profiles.
- disabled boolean
Lists if the DNS profile is disabled.
- disabled_reason string
Reason the DNS profile is disabled. Max size = 5000.
dns_forward_config DnsForwardConfig required
Lists details of the DNS forward requests configuration.
dns_servers DnsServers[] required
Details of the DNS severs.
Array [dnsserver_ip string requiredThe DNS server IP address.
dnsserver_port integerThe DNS server port.
domain_names string[]The DNS server domain names.
forward_dnsservicerole_id stringThe DNS forward service role ID. Max size = 20.
ip_prefix stringThe DNS server IP prefix.
source_port integerThe DNS server source port.
]max_source_port integerThe DNS service max source port.
min_source_port int32The DNS service min source port.
send_to_all_dns_servers booleanIf the option es enabled to send to all DNS servers.
dns_queries_metadata DnsQueriesMetadata
Lists the DNS queries parameters that append the client metadata to the DNS query as it is sent to the upstream DNS server.
add_client_mac ClientMac
The client MAC address of the requestor to DNS queries which are forwarded upstream.
mac_encoding_format string requiredPossible values: [
base64
,hexadecimal
]The MAC encoding format.
add_customer_premises_equipment CustomerPremisesEquipment
The element ID, text, or element name is added based on the DNS query configuration.
identifier_text stringThe custom string added to the DNS query.
type string requiredPossible values: [
text
,element_id
,element_name
]The customer premises equipment type.
add_subnets Subnet[]
The subnet ID is added for the DNS query.
Array [ipv4_address stringThe IPv4 address for the add subnet.
ipv4_prefix_length int32 requiredThe prefix lenth of the IP4 address of the add subnet.
ipv6_address stringThe IPv6 address for the add subnet.
ipv6_prefix_length int32 requiredThe prefix lenth of the IPv6 address of the add subnet.
]dns_rebind_config DnsRebindConfig
The details of the DNS rebind configuration.
enable_localhost_rebind booleanEnable localhost rebind.
rebind_domains string[]The DNS rebind domain list.
stop_dns_rebind_privateip booleanStop the DNS rebind private IP.
dns_response_overrides DnsResponseOverrides
The details of the DNS response overrides.
aliases Alias[]
Details of the DNS alias record. This record points your domain name to a hostname instead of an IP address.
Array [mask int32Alias mask - Allowed range = 0-32.
original_end_ip stringThe alias original end IP address.
original_ip stringThe alias originap IP address.
original_start_ip stringThe alias original start IP address.
replace_ip string requiredThe alias replace IP address.
]bogus_nx_domains string[]The IP addresses that can be identified as Bogus NX Domains.
disable_private_ip_lookups booleanOption to disable private IP lookups.
ignore_ip_addresses string[]Ignore the IP addresses.
local_ttl integerThe local TTL value.
max_ttl integerThe max TTL value.
dnssec_config DnsSecConfig
The DNS secondary server configuration details.
disable_dnssec_timecheck booleanIf DNSSEC time check is disabled.
dns_check_unsigned booleanIf the DNS check is unsigned.
enabled booleanThe DNSSEC is enabled.
trust_anchors TrustAnchor[]
Details on the trust anchors.
Array [class stringThe class of the trust anchor.
domain stringThe domain of the trust anchor.
key_digest KeyDigest
The key digest details of the trust anchor.
algorithm integerIf key digest algorithm of the trust anchor. Max = 255.
digest stringThe key digest config. Max = 256.
digest_type integerThe trust anchor key digest type. Max = 255.
key_tag integerThe trust anchor key tag.
]domains_to_addresses DomainsToAddress[]
The unique domain to address mapping and the IP address.
Array [domain_names string[]The domain name.
ipv4_address stringThe IPv4 address for the domain to address mapping.
ipv6_address stringThe IPv6 address for the domain to address mapping.
]- edns_packet_max int32
The EDNS packets size. The default size is 4096.
- enable_dns_loop_detection boolean
If DNS loop detection is enabled.
- enable_dnssec_proxy boolean
If DNS second proxy is enabled.
- enable_strict_domain_name boolean
If DNS strict domain name is enabled.
- id string
The ID.
- inactive boolean
If the DNS profile is inactive.
- inactive_reason string
Reason the DNS profile is inactive. Max size = 5000.
- listen_dnsservicerole_id string
The ID mapped to the interfaces which are used for listening.
- listen_port int32
The port where the DNS is listening to the DNS queries.
- name string required
The DNS profile name.
- region string
Region
- tags string[]
An information field that can be added to identify the DNS profile.
{
"authoritative_config": {
"caa_records": [
{
"flags": "string",
"name": "string",
"tag": "string",
"value": "string"
}
],
"cname_records": [
{
"name": [
"string"
],
"target": "string",
"ttl": 0
}
],
"dns_resource_records": [
{
"hex_data": "string",
"name": "string",
"rr_number": 0
}
],
"host_records": [
{
"domain_names": [
"string"
],
"ipv4_address": "string",
"ipv6_address": "string",
"ttl": 0
}
],
"mx_host_records": [
{
"hostname": "string",
"mx_name": "string",
"preference": 0
}
],
"naptr_records": [
{
"flags": "string",
"name": "string",
"order": 0,
"preference": 0,
"regexp": "string",
"replacement": "string",
"service": "string"
}
],
"peers": [
"string"
],
"ptr_records": [
{
"name": "string",
"target": "string"
}
],
"secondary_servers": [
"string"
],
"servers": [
{
"dnsservicerole_id": "string",
"domain_name": "string"
}
],
"soa": [
{
"expiry": 0,
"host_master": "string",
"refresh": 0,
"retry": 0,
"serial_number": 0
}
],
"srv_hosts": [
{
"domain_name": "string",
"port": 0,
"priority": 0,
"protocol": "string",
"service": "string",
"target": 0,
"weight": 0
}
],
"synth_domains": [
{
"domain": "string",
"end_ipaddress": "string",
"ipaddress_prefix": "string",
"prefix": "string",
"start_ipaddress": "string"
}
],
"ttl": 0,
"txt_records": [
{
"domain_name": "string",
"texts": [
"string"
]
}
],
"zones": [
{
"domain_name": "string",
"exclude_prefix": [
"string"
],
"include_prefix": [
"string"
]
}
]
},
"cache_config": {
"cache_size": 0,
"disable_negative_caching": true,
"max_cache_ttl": 0,
"min_cache_ttl": 0,
"negative_cache_ttl": 0
},
"disabled": true,
"disabled_reason": "string",
"dns_forward_config": {
"dns_servers": [
{
"dnsserver_ip": "string",
"dnsserver_port": 0,
"domain_names": [
"string"
],
"forward_dnsservicerole_id": "string",
"ip_prefix": "string",
"source_port": 0
}
],
"max_source_port": 0,
"min_source_port": 0,
"send_to_all_dns_servers": true
},
"dns_queries_metadata": {
"add_client_mac": {
"mac_encoding_format": "base64"
},
"add_customer_premises_equipment": {
"identifier_text": "string",
"type": "text"
},
"add_subnets": [
{
"ipv4_address": "string",
"ipv4_prefix_length": 0,
"ipv6_address": "string",
"ipv6_prefix_length": 0
}
]
},
"dns_rebind_config": {
"enable_localhost_rebind": true,
"rebind_domains": [
"string"
],
"stop_dns_rebind_privateip": true
},
"dns_response_overrides": {
"aliases": [
{
"mask": 0,
"original_end_ip": "string",
"original_ip": "string",
"original_start_ip": "string",
"replace_ip": "string"
}
],
"bogus_nx_domains": [
"string"
],
"disable_private_ip_lookups": true,
"ignore_ip_addresses": [
"string"
],
"local_ttl": 0,
"max_ttl": 0
},
"dnssec_config": {
"disable_dnssec_timecheck": true,
"dns_check_unsigned": true,
"enabled": true,
"trust_anchors": [
{
"class": "string",
"domain": "string",
"key_digest": {
"algorithm": 0,
"digest": "string",
"digest_type": 0,
"key_tag": 0
}
}
]
},
"domains_to_addresses": [
{
"domain_names": [
"string"
],
"ipv4_address": "string",
"ipv6_address": "string"
}
],
"edns_packet_max": 0,
"enable_dns_loop_detection": true,
"enable_dnssec_proxy": true,
"enable_strict_domain_name": true,
"id": "string",
"inactive": true,
"inactive_reason": "string",
"listen_dnsservicerole_id": "string",
"listen_port": 0,
"name": "string",
"region": "string",
"tags": [
"string"
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
_error ErrorResponse[]
Array [code stringmessage string]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "DNSPROFILE_CONFIG_DELETE_NOTALLOWED"
}
]
}
}