Create DNS Service Config (v2.0)
Create a new DNS service config.
Path Parameters
- site_id string required
Site ID of the target resource.
- element_id string required
Element ID of the target device.
- application/json
Request Body
Details of the DNS service config to be created
cache_config ElemCacheConfig
Lists details of the cache configuration.
cache_size int32The cache size.
- description
The description of the DNS service configs. Max size = 1024.
- disabled boolean
List the disabled DNS service configs.
- disabled_reason string
List the disabled DNS service configs reason.
dns_queries_metadata ElemDnsQueriesMetadata
Lists the DNS queries parameters that append the client metadata to the DNS query as it is sent to the upstream DNS server.
add_customer_premises_equipment ElemCustomerPremisesEquipment
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.
]- dnsservice_profile_id string
The DNS service profile ID.
dnsservicerole_bindings DnsServiceroleBindings[]
The bindings of the DNS srevice role.
Array [dnsservicerole_id stringThe DNS service role ID.
interfaces Interface[] required
The DNS role binding interfaces.
Array [interface_id stringThe interface ID.
interface_ip stringThe DNS server interface IP.
]]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.
]domains_to_interfaces DomainsToInterface[]
The domain to interface mapping details.
Array [domain_names string[] requiredThe domains to interface domain name.
interface_id string requiredThe interface ID.
]- element_id string
The element ID.
- enabled boolean
The enabled DNS service configs.
- id string
The ID of the DNS service configs.
- inactive boolean
Lists the inactive DNS service configs.
- inactive_reason string
Reason the DNS service config is inactive.
- max_concurrent_dns_queries int32
The max number of concurrent DNS queries.
- name string required
Name of the DNS service config.
- region string
Region
- site_id string required
ID of the site.
- tags string[]
A information field that can be added to identify the DNS service roles. Maximum 10 unique tags of length 1024 each are allowed.
- upperCaseName string
The upper case names.
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
cache_config ElemCacheConfig
Lists details of the cache configuration.
cache_size int32The cache size.
- description
The description of the DNS service configs. Max size = 1024.
- disabled boolean
List the disabled DNS service configs.
- disabled_reason string
List the disabled DNS service configs reason.
dns_queries_metadata ElemDnsQueriesMetadata
Lists the DNS queries parameters that append the client metadata to the DNS query as it is sent to the upstream DNS server.
add_customer_premises_equipment ElemCustomerPremisesEquipment
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.
]- dnsservice_profile_id string
The DNS service profile ID.
dnsservicerole_bindings DnsServiceroleBindings[]
The bindings of the DNS srevice role.
Array [dnsservicerole_id stringThe DNS service role ID.
interfaces Interface[] required
The DNS role binding interfaces.
Array [interface_id stringThe interface ID.
interface_ip stringThe DNS server interface IP.
]]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.
]domains_to_interfaces DomainsToInterface[]
The domain to interface mapping details.
Array [domain_names string[] requiredThe domains to interface domain name.
interface_id string requiredThe interface ID.
]- element_id string
The element ID.
- enabled boolean
The enabled DNS service configs.
- id string
The ID of the DNS service configs.
- inactive boolean
Lists the inactive DNS service configs.
- inactive_reason string
Reason the DNS service config is inactive.
- max_concurrent_dns_queries int32
The max number of concurrent DNS queries.
- name string required
Name of the DNS service config.
- region string
Region
- site_id string required
ID of the site.
- tags string[]
A information field that can be added to identify the DNS service roles. Maximum 10 unique tags of length 1024 each are allowed.
- upperCaseName string
The upper case names.
{
"cache_config": {
"cache_size": 0
},
"disabled": true,
"disabled_reason": "string",
"dns_queries_metadata": {
"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
}
]
},
"dnsservice_profile_id": "string",
"dnsservicerole_bindings": [
{
"dnsservicerole_id": "string",
"interfaces": [
{
"interface_id": "string",
"interface_ip": "string"
}
]
}
],
"domains_to_addresses": [
{
"domain_names": [
"string"
],
"ipv4_address": "string",
"ipv6_address": "string"
}
],
"domains_to_interfaces": [
{
"domain_names": [
"string"
],
"interface_id": "string"
}
],
"element_id": "string",
"enabled": true,
"id": "string",
"inactive": true,
"inactive_reason": "string",
"max_concurrent_dns_queries": 0,
"name": "string",
"region": "string",
"site_id": "string",
"tags": [
"string"
],
"upperCaseName": "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": "ELEMENT_DNSSERVICE_UNSUPPORTED"
},
{
"code": "SITE_MISMATCH"
},
{
"code": "HUB_UNSUPPORTED"
},
{
"code": "ELEMENT_MISMATCH"
},
{
"code": "ELEMENT_UNASSIGNED"
},
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "INVALID_REQUEST_DUPLICATE_KEY"
},
{
"code": "INVALID_PROFILE_ID"
},
{
"code": "INVALID_DNSROLE_ID"
},
{
"code": "INVALID_INTERFACE_CONFIG"
},
{
"code": "DTI_DOMAIN_CONFIG_INVALID_HOST"
},
{
"code": "DTA_DOMAIN_CONFIG_INVALID_HOST"
},
{
"code": "DNSSERVER_IP_CONFIG_INVALID_IP"
},
{
"code": "INVALID_CUSTOMER_PREMISES_EQUIPMENT_TYPE"
},
{
"code": "DNSQUERYMETADATA_CONFIG_INVALID_IP_ADDRESS"
},
{
"code": "DNSQUERYMETADATA_CONFIG_INVALID_IP_PREFIX_LENGTH_RANGE"
},
{
"code": "DNSQUERYMETADATA_CONFIG_INVALID_IPV6_ADDRESS"
},
{
"code": "DNSQUERYMETADATA_CONFIG_INVALID_IPV6_PREFIX_LENGTH_RANGE"
},
{
"code": "INVALID_DOMAINTOADDRESS_DOMAIN_NAMES_LIST_CONFIG"
},
{
"code": "DOMAINTOADDRESS_IP_CONFIG_MISSING"
}
]
}
}