Citrix ADC 12.1 NITRO API Reference

appfwprofile_xmlvalidationurl_binding

Binding object showing the xmlvalidationurl that can be bound to appfwprofile.

Properties

(click to see Operations)

Name Data Type Permissions Description
state Read-write Enabled.
Possible values = ENABLED, DISABLED
xmlwsdl Read-write WSDL object for soap request validation.
xmlendpointcheck Read-write Modifies the behaviour of the Request URL validation w.r.t. the Service URL. If set to ABSOLUTE, the entire request URL is validated with the entire URL mentioned in Service of the associated WSDL. eg: Service URL: http://example.org/ExampleService, Request URL: http//example.com/ExampleService would FAIL the validation. If set to RELAIVE, only the non-hostname part of the request URL is validated against the non-hostname part of the Service URL. eg: Service URL: http://example.org/ExampleService, Request URL: http//example.com/ExampleService would PASS the validation.
Possible values = ABSOLUTE, RELATIVE
name Read-write Name of the profile to which to bind an exemption or rule.
Minimum length = 1
xmlvalidateresponse Read-write Validate response message.
Possible values = ON, OFF
xmlvalidationurl Read-write XML Validation URL regular expression.
xmlresponseschema Read-write XML Schema object for response validation.
xmlvalidatesoapenvelope Read-write Validate SOAP Evelope only.
Possible values = ON, OFF
xmlrequestschema Read-write XML Schema object for request validation .
xmladditionalsoapheaders Read-write Allow addtional soap headers.
Possible values = ON, OFF
comment Read-write Any comments about the purpose of profile, or other useful information about the profile.
__count Read-write count parameter

Operations

(click to see Properties)

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/appfwprofile_xmlvalidationurl_binding

HTTP Method:PUT

Request Headers:

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

Request Payload:

{ "appfwprofile_xmlvalidationurl_binding":{ <b>"name":<String_value>, </b>"comment":<String_value>, "state":<String_value>, "xmlvalidationurl":<String_value>, "xmlrequestschema":<String_value>, "xmlresponseschema":<String_value>, "xmlwsdl":<String_value>, "xmladditionalsoapheaders":<String_value>, "xmlendpointcheck":<String_value>, "xmlvalidatesoapenvelope":<String_value>, "xmlvalidateresponse":<String_value> }}

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/appfwprofile_xmlvalidationurl_binding/name_value<String>

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwprofile_xmlvalidationurl_binding/name_value<String>?args=xmlvalidationurl:<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/appfwprofile_xmlvalidationurl_binding/name_value<String>

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of appfwprofile_xmlvalidationurl_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/appfwprofile_xmlvalidationurl_binding/name_value<String>?pagesize=#no;pageno=#no

Use this query-parameter to get the appfwprofile_xmlvalidationurl_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:

{ "appfwprofile_xmlvalidationurl_binding": [ { "state":<String_value>, "xmlwsdl":<String_value>, "xmlendpointcheck":<String_value>, "name":<String_value>, "xmlvalidateresponse":<String_value>, "xmlvalidationurl":<String_value>, "xmlresponseschema":<String_value>, "xmlvalidatesoapenvelope":<String_value>, "xmlrequestschema":<String_value>, "xmladditionalsoapheaders":<String_value>, "comment":<String_value> }]}

get (all)

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

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwprofile_xmlvalidationurl_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:

{ "appfwprofile_xmlvalidationurl_binding": [ { "state":<String_value>, "xmlwsdl":<String_value>, "xmlendpointcheck":<String_value>, "name":<String_value>, "xmlvalidateresponse":<String_value>, "xmlvalidationurl":<String_value>, "xmlresponseschema":<String_value>, "xmlvalidatesoapenvelope":<String_value>, "xmlrequestschema":<String_value>, "xmladditionalsoapheaders":<String_value>, "comment":<String_value> }]}

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwprofile_xmlvalidationurl_binding/name_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:

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