svcbindings

Last published : Oct 30, 2026
Configuration for service bindings resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
servicename <String> Read-write The name of the service.
Minimum length = 1
ipaddress <String> Read-only The IP address of the vserver.
port <Integer> Read-only The port of the vserver.
Range 1 - 65535
* in CLI is represented as 65535 in NITRO API
svrstate <String> Read-only The state of the vserver.
Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
vservername <String> Read-only The name of the vserver.
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • GET (ALL)
  • GET
  • 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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/svcbindings Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/svcbindings? args= servicename:<String_value>,
Use this query-parameter to get svcbindings resources based on additional properties.
attrs http:// <netscaler-ip-address> /nitro/v1/config/svcbindings? 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/svcbindings? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of svcbindings resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/svcbindings? view=summary
Use this query-parameter to get the summary output of svcbindings 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/svcbindings? pagesize=#no;pageno=#no
Use this query-parameter to get the svcbindings 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:

{ "svcbindings": [ {
<b>servicename:<String_value>,</b>"ipaddress":<String_value>,
"port":<Integer_value>,
"svrstate":<String_value>,
"vservername":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/svcbindings/ servicename_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/svcbindings/ servicename_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/svcbindings/ servicename_value<String> ? view=summary
Use this query-parameter to get the summary output of svcbindings resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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:

{  "svcbindings": [ {
<b>servicename:<String_value>,</b>"ipaddress":<String_value>,
"port":<Integer_value>,
"svrstate":<String_value>,
"vservername":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/svcbindings? args= servicename:<String_value>, ;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:

{ "svcbindings": [ { "__count": "#no"} ] }