Skip to main content

Create DNS Service Config (v2.0)

POST 

/sdwan/v2.0/api/sites/:site_id/elements/:element_id/dnsservices

Create a new DNS service config.

Request

Path Parameters

    site_id stringrequired

    Site ID of the target resource.

    element_id stringrequired

    Element ID of the target device.

Body

Details of the DNS service config to be created

    cache_config ElemCacheConfig

    Lists details of the cache configuration.

    cache_size int32

    The 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 string

    The custom string added to the DNS query.

    type stringrequired

    Possible 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 string

    The IPv4 address for the add subnet.

    ipv4_prefix_length int32required

    The prefix lenth of the IP4 address of the add subnet.

    ipv6_address string

    The IPv6 address for the add subnet.

    ipv6_prefix_length int32required

    The 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 string

    The DNS service role ID.

    interfaces Interface[]required

    The DNS role binding interfaces.

  • Array [
  • interface_id string

    The interface ID.

    interface_ip string

    The 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 string

    The IPv4 address for the domain to address mapping.

    ipv6_address string

    The IPv6 address for the domain to address mapping.

  • ]
  • domains_to_interfaces DomainsToInterface[]

    The domain to interface mapping details.

  • Array [
  • domain_names string[]required

    The domains to interface domain name.

    interface_id stringrequired

    The 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 stringrequired

    Name of the DNS service config.

    region string

    Region

    site_id stringrequired

    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.

Responses

Successful Operation

Schema
    cache_config ElemCacheConfig

    Lists details of the cache configuration.

    cache_size int32

    The 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 string

    The custom string added to the DNS query.

    type stringrequired

    Possible 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 string

    The IPv4 address for the add subnet.

    ipv4_prefix_length int32required

    The prefix lenth of the IP4 address of the add subnet.

    ipv6_address string

    The IPv6 address for the add subnet.

    ipv6_prefix_length int32required

    The 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 string

    The DNS service role ID.

    interfaces Interface[]required

    The DNS role binding interfaces.

  • Array [
  • interface_id string

    The interface ID.

    interface_ip string

    The 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 string

    The IPv4 address for the domain to address mapping.

    ipv6_address string

    The IPv6 address for the domain to address mapping.

  • ]
  • domains_to_interfaces DomainsToInterface[]

    The domain to interface mapping details.

  • Array [
  • domain_names string[]required

    The domains to interface domain name.

    interface_id stringrequired

    The 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 stringrequired

    Name of the DNS service config.

    region string

    Region

    site_id stringrequired

    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.

Loading...