Citrix ADC 12.1 NITRO API Reference

nsservicepath_nsservicefunction_binding

Binding object showing the nsservicefunction that can be bound to nsservicepath.

Properties

(click to see Operations)

Name Data Type Permissions Description
servicepathname Read-write Name for the Service path. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
Minimum length = 1
index Read-write The serviceindex of each servicefunction in path.
Minimum value = 1
servicefunction Read-write List of service functions constituting the chain.
Minimum length = 1
__count Read-write count parameter

Operations

(click to see Properties)

ADD: DELETE: GET 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

add

URL:http://<Citrix-ADC-IP-address(NSIP)/nitro/v1/config/nsservicepath_nsservicefunction_binding

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:


{
"nsservicepath_nsservicefunction_binding":{
<b>"servicepathname":<String_value>,
</b><b>"servicefunction":<String_value>,
</b><b>"index":<Double_value></b>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

delete

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding/servicepathname_value<String>

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding/servicepathname_value<String>?args=servicefunction:<String_value>

HTTP Method:DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue>

Response:

HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding/servicepathname_value<String>

Query-parameters:

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding/servicepathname_value<String>?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of nsservicepath_nsservicefunction_binding resources configured on Citrix ADC. Filtering can be done on any of the properties of the resource.

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding/servicepathname_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the nsservicepath_nsservicefunction_binding 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


{ "nsservicepath_nsservicefunction_binding": [ {
"servicepathname":<String_value>,
"index":<Double_value>,
"servicefunction":<String_value>
}]}

<!--NeedCopy-->

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


{ "nsservicepath_nsservicefunction_binding": [ {
"servicepathname":<String_value>,
"index":<Double_value>,
"servicefunction":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/nsservicepath_nsservicefunction_binding/servicepathname_value<String>?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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


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

<!--NeedCopy-->
nsservicepath_nsservicefunction_binding