Skip to main content

Get a DNS proxy

GET 
/dns-proxies/:id

Get an existing DNS proxy.

Request​

Path Parameters

    id uuidrequired

    The UUID of the configuration resource

Responses​

OK

Schema
    oneOf
    folder stringrequired

    Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z\d-_\. ]+$

    The folder in which the resource is defined

    id string

    UUID of the resource

    name stringrequired

    Possible values: <= 31 characters

    DNS proxy name

    enabled

    Default value: boolean

    Enable DNS proxy?

    default objectrequired
    inheritance object
    source string

    Dynamic interface

    primary stringrequired

    Primary DNS Name server IP address

    secondary string

    Secondary DNS Name server IP address

    interface string[]

    Interfaces on which to enable DNS proxy service

    domain-servers object[]

    DNS proxy rules

  • Array [
    • name stringrequired

    Proxy rule name

    cacheable

    Default value: boolean

    Enable caching for this DNS proxy rule?

    domain-name fqdn[]required

    Possible values: <= 128 characters

    Domain names(s) that will be matched

    primary ip-addressrequired

    Primary DNS server IP address

    secondary ip-address

    Secondary DNS server IP address

  • ]
    • static-entries object[]
  • Array [
    • name stringrequired

    Possible values: <= 31 characters

    Static entry name

    domain stringrequired

    Possible values: <= 255 characters

    Fully qualified domain name

    address ip-address[]required

    Possible values: <= 63 characters

  • ]
    • tcp-queries object
    enabled booleanrequired

    Turn on forwarding of TCP DNS queries?

    max-pending-requests integer

    Possible values: >= 64 and <= 256

    Default value: 64

    Upper limit on number of concurrent TCP DNS requests

    udp-queries object
    retries
    interval integer

    Possible values: >= 1 and <= 30

    Default value: 2

    Time in seconds for another request to be sent

    attempts integer

    Possible values: >= 1 and <= 30

    Default value: 5

    Maximum number of retries before trying next name server

    cache object
    enabled booleanrequired

    Default value: true

    Turn on caching for this DNS object

    cache-edns boolean

    Default value: true

    Cache EDNS UDP response

    max-ttl object
    enabled booleanrequired

    Enable max ttl for this DNS object

    time-to-live integer

    Possible values: >= 60 and <= 86400

    Time in seconds after which entry is cleared

Loading...