Firefox [Link]

! CloudDocs Home (/) > F5 BIG-IQ API (../../[Link]) > DNS Wide IP NAPTR

DNS Wide IP NAPTR¶

Overview¶

This document describes the API to configure DNS NAPTR wide IPs and their properties.

REST Endpoint: /mgmt/cm/dns/working-config/wideip/naptr¶

Requests¶

GET /mgmt/cm/dns/working-config/wideip/naptr/<id>¶

Request Parameters¶

None

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name Type Description

enabled boolean Specifies whether the

system can use this
wide IP and its
resources for load
balancing. The default
setting is Enabled

1 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcode string Specifies the DNS

RCODE used when
Return Code On Failure
is enabled. The default
is NOERROR (No Error).
If SOA Negative
Caching TTL is non-
zero, only the Authority
section of the
NOERROR or
NXDOMAIN response
will include a SOA
record. noerror:
Indicates that no type
exists at this name.
formerr: Indicates that a
format error exists in
the query. servfail:
Indicates that the
system is unable to
process the query.
nxdomain: Indicates
that the name does not
exist. notimpl: Indicates
that there is no support
for this kind of query.
refused: Indicates that
the system refuses to
process based on
policy

2 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcodeResponse string When enabled,

specifies that the
system returns a
RCODE response to
Wide IP requests after
exhausting all load-
balancing methods.
This response is an
authoritative empty
answer from the system
to NAPTR record
requests. The default is
Disabled

failureRcodeTtl number Specifies the negative

caching TTL of the SOA
for the RCODE
response. The default is
0 (zero), meaning no
SOA is included, which
results in no caching

lastResortPool string Specifies which pool,

for the system to use as
the last resort pool for
the wide IP

3 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

loadBalancingDecisionLogVerbosity array_of_strings Specifies which load

balancing decisions the
system displays in the
logs. pool-selection:
When checked
(enabled), the system
logs the pool selected
to handle a request.
pool-traversal: When
checked (enabled), the
system logs each pool
that was considered in
a load balancing
decision. pool-member-
selection: When
checked (enabled), the
system logs the pool
member selected to
handle a request. pool-
member-traversal:
When checked
(enabled), the system
logs each pool member
that was considered in
a load balancing
decision

4 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

minimalResponse string Specifies that the

system forms the
smallest allowable DNS
response to a query.
Typically, this is a single
resource record in the
answer section. When
set to disabled, the
system attempts to
chase CNAME chains, if
required, to obtain the
ultimate answer, and it
attempts to add
address resource
records to the
additional section of the
response for each
answer when needed.
The default is Enabled

persistCidrIpv4 number Specifies the number of

bits the system uses to
identify IPv4 addresses
when Persistence is
enabled. The default is
32

persistCidrIpv6 number Specifies the number of

bits the system uses to
identify IPv6 addresses
when Persistence is
enabled. The default is
128

5 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

persistence string Specifies, when

checked, that when a
local DNS makes
repetitive requests on
behalf of a client, the
system reconnects the
client to the same
resource as previous
requests

6 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

poolLbMode string Specifies the load

balancing method used
to select a pool in this
wide IP. This setting is
relevant only when
multiple pools are
configured for a wide IP.
global-availability: The
system selects a pool
by following the order
of the Pool List. The
system repeatedly
selects the first pool in
the list for as long as its
status is available. If the
pool becomes
unavailable for any
reason, the system then
repeatedly selects the
next pool in the list, and
so on. ratio: The system
selects a pool based on
the ratio that you assign
to the pool. round-
robin: The system
selects the pools
sequentially. topology:
The system selects a
pool based on topology
information in the
incoming LDNS request.
Note that this load
balancing method

7 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

works only if you have
defined a topology
statement

ttlPersistence number Specifies, in seconds,

the length of time for
which the persistence
entry is valid. The
default is 3600

type string Specifies the type of

this wide IP. DNS wide
IPs need to be keyed by
query type in addition
to name, since pool
members need different
attributes depending on
the response RDATA
they are meant to
supply

poolReferences array_of_objects

poolReference reference A pool reference for this

wide IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

8 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

poolCnameReferences array_of_objects

poolReference reference A pool CNAME

reference for this wide
IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

aliases array_of_strings Specifies alternate

domain names for the
web site content you
are load balancing

9 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

rulesReference reference Specifies references for

iRules that this wide IP
uses for load balancing
decisions. The system
evaluates the iRules in
the order in which they
are listed, until it finds a
matching iRule

name string Name of the resource

link string URI link of the

reference.

partition string The BIG-IP partition in

which the configuration
for this object is placed

name string Displays the name of

the wide IP

description string A description of the

wide IP

deviceGroupReference reference DNS Sync Group on

which this object is
deployed

name string Name of the resource

link string URI link of the

reference.

Permissions¶

Role Allow

Application_Editor Yes

DNS_Viewer Yes

DNS_Deployer Yes

10 of 83 8/17/25, 1:19 PM
Firefox [Link]

Role Allow

Service_Catalog_Viewer Yes

DNS_Editor Yes

Service_Catalog_Editor Yes

Application_Manager Yes

Application_Viewer Yes

Trust_Discovery_Import Yes

DNS_Manager Yes

POST /mgmt/cm/dns/working-config/wideip/naptr¶

Request Parameters¶

Name Type Required Description

enabled boolean False Specifies

whether the
system can use
this wide IP
and its
resources for
load balancing.
The default
setting is
Enabled

11 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

failureRcode string False Specifies the

DNS RCODE
used when
Return Code
On Failure is
enabled. The
default is
NOERROR (No
Error). If SOA
Negative
Caching TTL is
non-zero, only
the Authority
section of the
NOERROR or
NXDOMAIN
response will
include a SOA
record. noerror:
Indicates that
no type exists
at this name.
formerr:
Indicates that a
format error
exists in the
query. servfail:
Indicates that
the system is
unable to
process the
query.
nxdomain:

12 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

Indicates that
the name does
not exist.
notimpl:
Indicates that
there is no
support for this
kind of query.
refused:
Indicates that
the system
refuses to
process based
on policy

13 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

failureRcodeResponse string False When enabled,

specifies that
the system
returns a
RCODE
response to
Wide IP
requests after
exhausting all
load-balancing
methods. This
response is an
authoritative
empty answer
from the
system to
NAPTR record
requests. The
default is
Disabled

14 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

failureRcodeTtl number False Specifies the

negative
caching TTL of
the SOA for the
RCODE
response. The
default is 0
(zero),
meaning no
SOA is
included, which
results in no
caching

lastResortPool string False Specifies which

pool, for the
system to use
as the last
resort pool for
the wide IP

15 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

loadBalancingDecisionLogVerbosity array_of_strings False Specifies which

load balancing
decisions the
system
displays in the
logs. pool-
selection:
When checked
(enabled), the
system logs
the pool
selected to
handle a
request. pool-
traversal: When
checked
(enabled), the
system logs
each pool that
was considered
in a load
balancing
decision. pool-
member-
selection:
When checked
(enabled), the
system logs
the pool
member
selected to
handle a
request. pool-

16 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

member-
traversal: When
checked
(enabled), the
system logs
each pool
member that
was considered
in a load
balancing
decision

17 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

minimalResponse string False Specifies that

the system
forms the
smallest
allowable DNS
response to a
query.
Typically, this is
a single
resource
record in the
answer section.
When set to
disabled, the
system
attempts to
chase CNAME
chains, if
required, to
obtain the
ultimate
answer, and it
attempts to
add address
resource
records to the
additional
section of the
response for
each answer
when needed.
The default is
Enabled

18 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

persistCidrIpv4 number False Specifies the

number of bits
the system
uses to identify
IPv4 addresses
when
Persistence is
enabled. The
default is 32

persistCidrIpv6 number False Specifies the

number of bits
the system
uses to identify
IPv6 addresses
when
Persistence is
enabled. The
default is 128

19 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

persistence string False Specifies,

when checked,
that when a
local DNS
makes
repetitive
requests on
behalf of a
client, the
system
reconnects the
client to the
same resource
as previous
requests

20 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

poolLbMode string False Specifies the

load balancing
method used
to select a pool
in this wide IP.
This setting is
relevant only
when multiple
pools are
configured for
a wide IP.
global-
availability: The
system selects
a pool by
following the
order of the
Pool List. The
system
repeatedly
selects the first
pool in the list
for as long as
its status is
available. If the
pool becomes
unavailable for
any reason, the
system then
repeatedly
selects the
next pool in the
list, and so on.

21 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

ratio: The
system selects
a pool based
on the ratio
that you assign
to the pool.
round-robin:
The system
selects the
pools
sequentially.
topology: The
system selects
a pool based
on topology
information in
the incoming
LDNS request.
Note that this
load balancing
method works
only if you have
defined a
topology
statement

22 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

ttlPersistence number False Specifies, in

seconds, the
length of time
for which the
persistence
entry is valid.
The default is
3600

type string False Specifies the

type of this
wide IP. DNS
wide IPs need
to be keyed by
query type in
addition to
name, since
pool members
need different
attributes
depending on
the response
RDATA they are
meant to
supply

poolReferences array_of_objects False

poolReference reference False A pool

reference for
this wide IP to
use for load
balancing

link string True URI link of the

reference.

23 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

order number False Specifies the

order of this
pool. The
system
evaluates the
pools in the
order in which
they are listed,
until it finds a
matching pool

ratio number False The system

uses this
number with
the Ratio load
balancing
method. The
default is 1

poolCnameReferences array_of_objects False

poolReference reference False A pool CNAME

reference for
this wide IP to
use for load
balancing

link string True URI link of the

reference.

24 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

order number False Specifies the

order of this
pool. The
system
evaluates the
pools in the
order in which
they are listed,
until it finds a
matching pool

ratio number False The system

uses this
number with
the Ratio load
balancing
method. The
default is 1

aliases array_of_strings False Specifies

alternate
domain names
for the web site
content you are
load balancing

25 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

rulesReference reference False Specifies

references for
iRules that this
wide IP uses
for load
balancing
decisions. The
system
evaluates the
iRules in the
order in which
they are listed,
until it finds a
matching iRule

link string True URI link of the

reference.

partition string False The BIG-IP

partition in
which the
configuration
for this object
is placed

name string False Displays the

name of the
wide IP

description string False A description

of the wide IP

26 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

deviceGroupReference reference False DNS Sync

Group on
which this
object is
deployed

link string True URI link of the

reference.

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name Type Description

enabled boolean Specifies whether the

system can use this
wide IP and its
resources for load
balancing. The default
setting is Enabled

27 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcode string Specifies the DNS

RCODE used when
Return Code On Failure
is enabled. The default
is NOERROR (No Error).
If SOA Negative
Caching TTL is non-
zero, only the Authority
section of the
NOERROR or
NXDOMAIN response
will include a SOA
record. noerror:
Indicates that no type
exists at this name.
formerr: Indicates that a
format error exists in
the query. servfail:
Indicates that the
system is unable to
process the query.
nxdomain: Indicates
that the name does not
exist. notimpl: Indicates
that there is no support
for this kind of query.
refused: Indicates that
the system refuses to
process based on
policy

28 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcodeResponse string When enabled,

specifies that the
system returns a
RCODE response to
Wide IP requests after
exhausting all load-
balancing methods.
This response is an
authoritative empty
answer from the system
to NAPTR record
requests. The default is
Disabled

failureRcodeTtl number Specifies the negative

caching TTL of the SOA
for the RCODE
response. The default is
0 (zero), meaning no
SOA is included, which
results in no caching

lastResortPool string Specifies which pool,

for the system to use as
the last resort pool for
the wide IP

29 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

loadBalancingDecisionLogVerbosity array_of_strings Specifies which load

balancing decisions the
system displays in the
logs. pool-selection:
When checked
(enabled), the system
logs the pool selected
to handle a request.
pool-traversal: When
checked (enabled), the
system logs each pool
that was considered in
a load balancing
decision. pool-member-
selection: When
checked (enabled), the
system logs the pool
member selected to
handle a request. pool-
member-traversal:
When checked
(enabled), the system
logs each pool member
that was considered in
a load balancing
decision

30 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

minimalResponse string Specifies that the

system forms the
smallest allowable DNS
response to a query.
Typically, this is a single
resource record in the
answer section. When
set to disabled, the
system attempts to
chase CNAME chains, if
required, to obtain the
ultimate answer, and it
attempts to add
address resource
records to the
additional section of the
response for each
answer when needed.
The default is Enabled

persistCidrIpv4 number Specifies the number of

bits the system uses to
identify IPv4 addresses
when Persistence is
enabled. The default is
32

persistCidrIpv6 number Specifies the number of

bits the system uses to
identify IPv6 addresses
when Persistence is
enabled. The default is
128

31 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

persistence string Specifies, when

checked, that when a
local DNS makes
repetitive requests on
behalf of a client, the
system reconnects the
client to the same
resource as previous
requests

32 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

poolLbMode string Specifies the load

balancing method used
to select a pool in this
wide IP. This setting is
relevant only when
multiple pools are
configured for a wide IP.
global-availability: The
system selects a pool
by following the order
of the Pool List. The
system repeatedly
selects the first pool in
the list for as long as its
status is available. If the
pool becomes
unavailable for any
reason, the system then
repeatedly selects the
next pool in the list, and
so on. ratio: The system
selects a pool based on
the ratio that you assign
to the pool. round-
robin: The system
selects the pools
sequentially. topology:
The system selects a
pool based on topology
information in the
incoming LDNS request.
Note that this load
balancing method

33 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

works only if you have
defined a topology
statement

ttlPersistence number Specifies, in seconds,

the length of time for
which the persistence
entry is valid. The
default is 3600

type string Specifies the type of

this wide IP. DNS wide
IPs need to be keyed by
query type in addition
to name, since pool
members need different
attributes depending on
the response RDATA
they are meant to
supply

poolReferences array_of_objects

poolReference reference A pool reference for this

wide IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

34 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

poolCnameReferences array_of_objects

poolReference reference A pool CNAME

reference for this wide
IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

aliases array_of_strings Specifies alternate

domain names for the
web site content you
are load balancing

35 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

rulesReference reference Specifies references for

iRules that this wide IP
uses for load balancing
decisions. The system
evaluates the iRules in
the order in which they
are listed, until it finds a
matching iRule

name string Name of the resource

link string URI link of the

reference.

partition string The BIG-IP partition in

which the configuration
for this object is placed

name string Displays the name of

the wide IP

description string A description of the

wide IP

deviceGroupReference reference DNS Sync Group on

which this object is
deployed

name string Name of the resource

link string URI link of the

reference.

Permissions¶

Role Allow

Application_Editor No

DNS_Viewer No

DNS_Deployer No

36 of 83 8/17/25, 1:19 PM
Firefox [Link]

Role Allow

Service_Catalog_Viewer No

DNS_Editor Yes

Service_Catalog_Editor No

Application_Manager No

Application_Viewer No

Trust_Discovery_Import No

DNS_Manager Yes

PATCH /mgmt/cm/dns/working-config/wideip/naptr/<id>¶

Request Parameters¶

Name Type Required Description

enabled boolean False Specifies

whether the
system can
use this wide
IP and its
resources for
load balancing.
The default
setting is
Enabled

37 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

failureRcode string False Specifies the

DNS RCODE
used when
Return Code
On Failure is
enabled. The
default is
NOERROR (No
Error). If SOA
Negative
Caching TTL is
non-zero, only
the Authority
section of the
NOERROR or
NXDOMAIN
response will
include a SOA
record.
noerror:
Indicates that
no type exists
at this name.
formerr:
Indicates that a
format error
exists in the
query. servfail:
Indicates that
the system is
unable to
process the
query.

38 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

nxdomain:
Indicates that
the name does
not exist.
notimpl:
Indicates that
there is no
support for this
kind of query.
refused:
Indicates that
the system
refuses to
process based
on policy

39 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

failureRcodeResponse string False When enabled,

specifies that
the system
returns a
RCODE
response to
Wide IP
requests after
exhausting all
load-balancing
methods. This
response is an
authoritative
empty answer
from the
system to
NAPTR record
requests. The
default is
Disabled

40 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

failureRcodeTtl number False Specifies the

negative
caching TTL of
the SOA for
the RCODE
response. The
default is 0
(zero),
meaning no
SOA is
included,
which results
in no caching

lastResortPool string False Specifies

which pool, for
the system to
use as the last
resort pool for
the wide IP

41 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

loadBalancingDecisionLogVerbosity array_of_strings False Specifies

which load
balancing
decisions the
system
displays in the
logs. pool-
selection:
When checked
(enabled), the
system logs
the pool
selected to
handle a
request. pool-
traversal:
When checked
(enabled), the
system logs
each pool that
was
considered in a
load balancing
decision. pool-
member-
selection:
When checked
(enabled), the
system logs
the pool
member
selected to
handle a

42 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

request. pool-
member-
traversal:
When checked
(enabled), the
system logs
each pool
member that
was
considered in a
load balancing
decision

43 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

minimalResponse string False Specifies that

the system
forms the
smallest
allowable DNS
response to a
query.
Typically, this
is a single
resource
record in the
answer
section. When
set to disabled,
the system
attempts to
chase CNAME
chains, if
required, to
obtain the
ultimate
answer, and it
attempts to
add address
resource
records to the
additional
section of the
response for
each answer
when needed.
The default is
Enabled

44 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

persistCidrIpv4 number False Specifies the

number of bits
the system
uses to identify
IPv4 addresses
when
Persistence is
enabled. The
default is 32

persistCidrIpv6 number False Specifies the

number of bits
the system
uses to identify
IPv6 addresses
when
Persistence is
enabled. The
default is 128

45 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

persistence string False Specifies,

when checked,
that when a
local DNS
makes
repetitive
requests on
behalf of a
client, the
system
reconnects the
client to the
same resource
as previous
requests

46 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

poolLbMode string False Specifies the

load balancing
method used
to select a pool
in this wide IP.
This setting is
relevant only
when multiple
pools are
configured for
a wide IP.
global-
availability: The
system selects
a pool by
following the
order of the
Pool List. The
system
repeatedly
selects the
first pool in the
list for as long
as its status is
available. If the
pool becomes
unavailable for
any reason, the
system then
repeatedly
selects the
next pool in
the list, and so

47 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

on. ratio: The
system selects
a pool based
on the ratio
that you assign
to the pool.
round-robin:
The system
selects the
pools
sequentially.
topology: The
system selects
a pool based
on topology
information in
the incoming
LDNS request.
Note that this
load balancing
method works
only if you
have defined a
topology
statement

48 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

ttlPersistence number False Specifies, in

seconds, the
length of time
for which the
persistence
entry is valid.
The default is
3600

type string False Specifies the

type of this
wide IP. DNS
wide IPs need
to be keyed by
query type in
addition to
name, since
pool members
need different
attributes
depending on
the response
RDATA they
are meant to
supply

poolReferences array_of_objects False

poolReference reference False A pool

reference for
this wide IP to
use for load
balancing

link string True URI link of the

reference.

49 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

order number False Specifies the

order of this
pool. The
system
evaluates the
pools in the
order in which
they are listed,
until it finds a
matching pool

ratio number False The system

uses this
number with
the Ratio load
balancing
method. The
default is 1

poolCnameReferences array_of_objects False

poolReference reference False A pool CNAME

reference for
this wide IP to
use for load
balancing

link string True URI link of the

reference.

50 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

order number False Specifies the

order of this
pool. The
system
evaluates the
pools in the
order in which
they are listed,
until it finds a
matching pool

ratio number False The system

uses this
number with
the Ratio load
balancing
method. The
default is 1

aliases array_of_strings False Specifies

alternate
domain names
for the web
site content
you are load
balancing

51 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Required Description

rulesReference reference False Specifies

references for
iRules that this
wide IP uses
for load
balancing
decisions. The
system
evaluates the
iRules in the
order in which
they are listed,
until it finds a
matching iRule

link string True URI link of the

reference.

description string False A description

of the wide IP

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name Type Description

enabled boolean Specifies whether the

system can use this
wide IP and its
resources for load
balancing. The default
setting is Enabled

52 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcode string Specifies the DNS

RCODE used when
Return Code On Failure
is enabled. The default
is NOERROR (No Error).
If SOA Negative
Caching TTL is non-
zero, only the Authority
section of the
NOERROR or
NXDOMAIN response
will include a SOA
record. noerror:
Indicates that no type
exists at this name.
formerr: Indicates that a
format error exists in
the query. servfail:
Indicates that the
system is unable to
process the query.
nxdomain: Indicates
that the name does not
exist. notimpl: Indicates
that there is no support
for this kind of query.
refused: Indicates that
the system refuses to
process based on
policy

53 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcodeResponse string When enabled,

specifies that the
system returns a
RCODE response to
Wide IP requests after
exhausting all load-
balancing methods.
This response is an
authoritative empty
answer from the system
to NAPTR record
requests. The default is
Disabled

failureRcodeTtl number Specifies the negative

caching TTL of the SOA
for the RCODE
response. The default is
0 (zero), meaning no
SOA is included, which
results in no caching

lastResortPool string Specifies which pool,

for the system to use as
the last resort pool for
the wide IP

54 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

loadBalancingDecisionLogVerbosity array_of_strings Specifies which load

balancing decisions the
system displays in the
logs. pool-selection:
When checked
(enabled), the system
logs the pool selected
to handle a request.
pool-traversal: When
checked (enabled), the
system logs each pool
that was considered in
a load balancing
decision. pool-member-
selection: When
checked (enabled), the
system logs the pool
member selected to
handle a request. pool-
member-traversal:
When checked
(enabled), the system
logs each pool member
that was considered in
a load balancing
decision

55 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

minimalResponse string Specifies that the

system forms the
smallest allowable DNS
response to a query.
Typically, this is a single
resource record in the
answer section. When
set to disabled, the
system attempts to
chase CNAME chains, if
required, to obtain the
ultimate answer, and it
attempts to add
address resource
records to the
additional section of the
response for each
answer when needed.
The default is Enabled

persistCidrIpv4 number Specifies the number of

bits the system uses to
identify IPv4 addresses
when Persistence is
enabled. The default is
32

persistCidrIpv6 number Specifies the number of

bits the system uses to
identify IPv6 addresses
when Persistence is
enabled. The default is
128

56 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

persistence string Specifies, when

checked, that when a
local DNS makes
repetitive requests on
behalf of a client, the
system reconnects the
client to the same
resource as previous
requests

57 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

poolLbMode string Specifies the load

balancing method used
to select a pool in this
wide IP. This setting is
relevant only when
multiple pools are
configured for a wide IP.
global-availability: The
system selects a pool
by following the order
of the Pool List. The
system repeatedly
selects the first pool in
the list for as long as its
status is available. If the
pool becomes
unavailable for any
reason, the system then
repeatedly selects the
next pool in the list, and
so on. ratio: The system
selects a pool based on
the ratio that you assign
to the pool. round-
robin: The system
selects the pools
sequentially. topology:
The system selects a
pool based on topology
information in the
incoming LDNS request.
Note that this load
balancing method

58 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

works only if you have
defined a topology
statement

ttlPersistence number Specifies, in seconds,

the length of time for
which the persistence
entry is valid. The
default is 3600

type string Specifies the type of

this wide IP. DNS wide
IPs need to be keyed by
query type in addition
to name, since pool
members need different
attributes depending on
the response RDATA
they are meant to
supply

poolReferences array_of_objects

poolReference reference A pool reference for this

wide IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

59 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

poolCnameReferences array_of_objects

poolReference reference A pool CNAME

reference for this wide
IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

aliases array_of_strings Specifies alternate

domain names for the
web site content you
are load balancing

60 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

rulesReference reference Specifies references for

iRules that this wide IP
uses for load balancing
decisions. The system
evaluates the iRules in
the order in which they
are listed, until it finds a
matching iRule

name string Name of the resource

link string URI link of the

reference.

partition string The BIG-IP partition in

which the configuration
for this object is placed

name string Displays the name of

the wide IP

description string A description of the

wide IP

deviceGroupReference reference DNS Sync Group on

which this object is
deployed

name string Name of the resource

link string URI link of the

reference.

Permissions¶

Role Allow

Application_Editor No

DNS_Viewer No

DNS_Deployer No

61 of 83 8/17/25, 1:19 PM
Firefox [Link]

Role Allow

Service_Catalog_Viewer No

DNS_Editor Yes

Service_Catalog_Editor No

Application_Manager No

Application_Viewer No

Trust_Discovery_Import No

DNS_Manager Yes

DELETE /mgmt/cm/dns/working-config/wideip/naptr/<id>¶

Request Parameters¶

None

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name Type Description

enabled boolean Specifies whether the

system can use this
wide IP and its
resources for load
balancing. The default
setting is Enabled

62 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcode string Specifies the DNS

RCODE used when
Return Code On Failure
is enabled. The default
is NOERROR (No Error).
If SOA Negative
Caching TTL is non-
zero, only the Authority
section of the
NOERROR or
NXDOMAIN response
will include a SOA
record. noerror:
Indicates that no type
exists at this name.
formerr: Indicates that a
format error exists in
the query. servfail:
Indicates that the
system is unable to
process the query.
nxdomain: Indicates
that the name does not
exist. notimpl: Indicates
that there is no support
for this kind of query.
refused: Indicates that
the system refuses to
process based on
policy

63 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

failureRcodeResponse string When enabled,

specifies that the
system returns a
RCODE response to
Wide IP requests after
exhausting all load-
balancing methods.
This response is an
authoritative empty
answer from the system
to NAPTR record
requests. The default is
Disabled

failureRcodeTtl number Specifies the negative

caching TTL of the SOA
for the RCODE
response. The default is
0 (zero), meaning no
SOA is included, which
results in no caching

lastResortPool string Specifies which pool,

for the system to use as
the last resort pool for
the wide IP

64 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

loadBalancingDecisionLogVerbosity array_of_strings Specifies which load

balancing decisions the
system displays in the
logs. pool-selection:
When checked
(enabled), the system
logs the pool selected
to handle a request.
pool-traversal: When
checked (enabled), the
system logs each pool
that was considered in
a load balancing
decision. pool-member-
selection: When
checked (enabled), the
system logs the pool
member selected to
handle a request. pool-
member-traversal:
When checked
(enabled), the system
logs each pool member
that was considered in
a load balancing
decision

65 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

minimalResponse string Specifies that the

system forms the
smallest allowable DNS
response to a query.
Typically, this is a single
resource record in the
answer section. When
set to disabled, the
system attempts to
chase CNAME chains, if
required, to obtain the
ultimate answer, and it
attempts to add
address resource
records to the
additional section of the
response for each
answer when needed.
The default is Enabled

persistCidrIpv4 number Specifies the number of

bits the system uses to
identify IPv4 addresses
when Persistence is
enabled. The default is
32

persistCidrIpv6 number Specifies the number of

bits the system uses to
identify IPv6 addresses
when Persistence is
enabled. The default is
128

66 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

persistence string Specifies, when

checked, that when a
local DNS makes
repetitive requests on
behalf of a client, the
system reconnects the
client to the same
resource as previous
requests

67 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

poolLbMode string Specifies the load

balancing method used
to select a pool in this
wide IP. This setting is
relevant only when
multiple pools are
configured for a wide IP.
global-availability: The
system selects a pool
by following the order
of the Pool List. The
system repeatedly
selects the first pool in
the list for as long as its
status is available. If the
pool becomes
unavailable for any
reason, the system then
repeatedly selects the
next pool in the list, and
so on. ratio: The system
selects a pool based on
the ratio that you assign
to the pool. round-
robin: The system
selects the pools
sequentially. topology:
The system selects a
pool based on topology
information in the
incoming LDNS request.
Note that this load
balancing method

68 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

works only if you have
defined a topology
statement

ttlPersistence number Specifies, in seconds,

the length of time for
which the persistence
entry is valid. The
default is 3600

type string Specifies the type of

this wide IP. DNS wide
IPs need to be keyed by
query type in addition
to name, since pool
members need different
attributes depending on
the response RDATA
they are meant to
supply

poolReferences array_of_objects

poolReference reference A pool reference for this

wide IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

69 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

poolCnameReferences array_of_objects

poolReference reference A pool CNAME

reference for this wide
IP to use for load
balancing

name string Name of the resource

link string URI link of the

reference.

order number Specifies the order of

this pool. The system
evaluates the pools in
the order in which they
are listed, until it finds a
matching pool

ratio number The system uses this

number with the Ratio
load balancing method.
The default is 1

aliases array_of_strings Specifies alternate

domain names for the
web site content you
are load balancing

70 of 83 8/17/25, 1:19 PM
Firefox [Link]

Name Type Description

rulesReference reference Specifies references for

iRules that this wide IP
uses for load balancing
decisions. The system
evaluates the iRules in
the order in which they
are listed, until it finds a
matching iRule

name string Name of the resource

link string URI link of the

reference.

partition string The BIG-IP partition in

which the configuration
for this object is placed

name string Displays the name of

the wide IP

description string A description of the

wide IP

deviceGroupReference reference DNS Sync Group on

which this object is
deployed

name string Name of the resource

link string URI link of the

reference.

Permissions¶

Role Allow

Application_Editor No

DNS_Viewer No

DNS_Deployer No

71 of 83 8/17/25, 1:19 PM
Firefox [Link]

Role Allow

Service_Catalog_Viewer No

DNS_Editor Yes

Service_Catalog_Editor No

Application_Manager No

Application_Viewer No

Trust_Discovery_Import No

DNS_Manager Yes

Examples¶

Get a wide IP of type NAPTR¶

GET /mgmt/cm/dns/working-config/wideip/naptr/<id>

Response¶

72 of 83 8/17/25, 1:19 PM
Firefox [Link]

HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "[Link]
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "[Link]

73 of 83 8/17/25, 1:19 PM
Firefox [Link]

}
}

Get all wide IPs of type NAPTR¶

GET /mgmt/cm/dns/working-config/wideip/naptr

Response¶

74 of 83 8/17/25, 1:19 PM
Firefox [Link]

HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "[Link]
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "[Link]

75 of 83 8/17/25, 1:19 PM
Firefox [Link]

}
}

Create new wide IP NAPTR¶

76 of 83 8/17/25, 1:19 PM
Firefox [Link]

POST /mgmt/cm/dns/working-config/wideip/naptr
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"link": "[Link]
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"link": "[Link]
}
}

Response¶

77 of 83 8/17/25, 1:19 PM
Firefox [Link]

HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "[Link]
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "[Link]

78 of 83 8/17/25, 1:19 PM
Firefox [Link]

}
}

Update wide IP NAPTR¶

PATCH /mgmt/cm/dns/working-config/wideip/naptr/<id>
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"link": "[Link]
}],
"description": "example server"
}

Response¶

79 of 83 8/17/25, 1:19 PM
Firefox [Link]

HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "[Link]
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "[Link]

80 of 83 8/17/25, 1:19 PM
Firefox [Link]

}
}

Delete wide IP NAPTR¶

DELETE /mgmt/cm/dns/working-config/wideip/naptr/<id>

Response¶

81 of 83 8/17/25, 1:19 PM
Firefox [Link]

HTTP/1.1 200 OK
{
"enabled": No example value specified ,
"failureRcode": No example value specified ,
"failureRcodeResponse": No example value specified ,
"failureRcodeTtl": No example value specified ,
"lastResortPool": No example value specified ,
"loadBalancingDecisionLogVerbosity": No example value specified ,
"minimalResponse": No example value specified ,
"persistCidrIpv4": No example value specified ,
"persistCidrIpv6": No example value specified ,
"persistence": No example value specified ,
"poolLbMode": No example value specified ,
"ttlPersistence": No example value specified ,
"type": No example value specified ,
"poolReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"poolCnameReferences": [{
"poolReference": {
"name": "resourceName" ,
"link": "[Link]
},
"order": No example value specified ,
"ratio": No example value specified
}],
"aliases": No example value specified ,
"rulesReference": [{
"name": "resourceName" ,
"link": "[Link]
}],
"partition": No example value specified ,
"name": "wideip1" ,
"description": "example server" ,
"deviceGroupReference": {
"name": "resourceName" ,
"link": "[Link]

82 of 83 8/17/25, 1:19 PM
Firefox [Link]

}
}

83 of 83 8/17/25, 1:19 PM