dnssvcbrec

Last published : Oct 30, 2026
Configuration for SVCB/HTTPS service binding record resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
domain <String> Read-write Domain name for the SVCB/HTTPS record.
Minimum length = 1
priority <Integer> Read-write Service priority (0 for AliasMode, >0 for ServiceMode).
Minimum value = 0
Maximum value = 65535
targetname <String> Read-write Target domain name.
Minimum length = 1
svcbtype <String> Read-write Service type: SVCB or HTTPS.
Default value: SVCB
Possible values = SVCB, HTTPS
alpn <String> Read-write Comma-separated list of ALPN protocol identifiers.
Minimum length = 1
port <Integer> Read-write Port number for the service.
Minimum value = 1
Maximum value = 65535
ipv4hint <String> Read-write Comma-separated list of IPv4 hint addresses.
Minimum length = 1
ipv6hint <String> Read-write Comma-separated list of IPv6 hint addresses.
Minimum length = 1
encryptedclienthello <String> Read-write Base64-encoded ECH configuration.
Minimum length = 1
nodefaultalpn <Boolean> Read-write Indicates no default ALPN protocols.
Default value: 0
mandatory <String> Read-write Comma-separated list of mandatory SvcParam keys.
Minimum length = 1
ttl <Integer> Read-write Time to Live (TTL) in seconds.
Default value: 3600
Minimum value = 0
Maximum value = 2147483647
type <String> Read-write Type of records: ADNS, PROXY, or ALL.
Possible values = ALL, ADNS, PROXY
nodeid <Integer> Read-write Unique number that identifies the cluster node.
Minimum value = 0
Maximum value = 31
ecssubnet <String> Read-only Subnet for which this particular record is cached. Subnet caching will occur for responses with EDNS Client Subnet (ECS) option. Applies to resource records obtained through proxy configurations only.
authtype <String> Read-only Record type (ADNS/PROXY/ALL).
Possible values = ALL, ADNS, PROXY
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • COUNT
Some options that you can use for each operations:
  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
    To do this, you must specify the username and password in the request header of the NITRO request as follows:
    X-NITRO-USER: <username>
    X-NITRO-PASS: <password>
    Note: In such cases, make sure that the request header DOES not include the following:
    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"dnssvcbrec":{
<b>"domain":<String_value>,
</b><b>"priority":<Integer_value>,
</b><b>"targetname":<String_value>,
</b>"svcbtype":<String_value>,
"alpn":<String_value>,
"port":<Integer_value>,
"ipv4hint":<String_value>,
"ipv6hint":<String_value>,
"encryptedclienthello":<String_value>,
"nodefaultalpn":<Boolean_value>,
"mandatory":<String_value>,
"ttl":<Integer_value>
}}
Response: HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec/ domain_value<String> Query-parameters: args=targetname: <String_value> ,priority: <Integer_value> ,svcbtype: <String_value>

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"dnssvcbrec":{
<b>"domain":<String_value>,
</b><b>"priority":<Integer_value>,
</b><b>"targetname":<String_value>,
</b>"svcbtype":<String_value>,
"alpn":<String_value>,
"port":<Integer_value>,
"ipv4hint":<String_value>,
"ipv6hint":<String_value>,
"encryptedclienthello":<String_value>,
"nodefaultalpn":<Boolean_value>,
"mandatory":<String_value>,
"ttl":<Integer_value>
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"dnssvcbrec":{
<b>"domain":<String_value>,
</b><b>"priority":<Integer_value>,
</b><b>"targetname":<String_value>,
</b>"svcbtype":<String_value>,
"alpn":true,
"port":true,
"ipv4hint":true,
"ipv6hint":true,
"encryptedclienthello":true,
"nodefaultalpn":true,
"mandatory":true,
"ttl":true
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? args=domain: <String_value> ,svcbtype: <String_value> ,type: <String_value> ,nodeid: <Integer_value>
Use this query-parameter to get dnssvcbrec resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of dnssvcbrec resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? view=summary
Use this query-parameter to get the summary output of dnssvcbrec resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? pagesize=#no;pageno=#no
Use this query-parameter to get the dnssvcbrec resources in chunks.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "dnssvcbrec": [ {
domain:<String_value>,svcbtype:<String_value>,type:<String_value>,nodeid:<Integer_value>"priority":<Integer_value>,
"targetname":<String_value>,
"ttl":<Integer_value>,
"ecssubnet":<String_value>,
"alpn":<String_value>,
"nodefaultalpn":<Boolean_value>,
"ipv4hint":<String_value>,
"ipv6hint":<String_value>,
"encryptedclienthello":<String_value>,
"mandatory":<String_value>,
"port":<Integer_value>,
"authtype":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/dnssvcbrec? count=yes HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "dnssvcbrec": [ { "__count": "#no"} ] }