ADC NITRO APIs

policypatset_pattern_binding

August 17, 2023

Contributed by:

Binding object showing the pattern that can be bound to policypatset.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
String	<String>	Read-write	String of characters that constitutes a pattern. For more information about the characters that can be used, refer to the character set parameter. Note: Minimum length for pattern sets used in rewrite actions of type REPLACE_ALL, DELETE_ALL, INSERT_AFTER_ALL, and INSERT_BEFORE_ALL, is three characters.
feature	<String>	Read-write	The feature to be checked while applying this config.
builtin	<String[]>	Read-write	Indicates that a variable is a built-in (SYSTEM INTERNAL) type. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
name	<String>	Read-write	Name of the pattern set to which to bind the string. Minimum length = 1
charset	<String>	Read-write	Character set associated with the characters in the string. Note: UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes '\xNN'. For example, the UTF-8 character 'ü' can be encoded as '\xC3\xBC'. Possible values = ASCII, UTF_8
index	<Double>	Read-write	The index of the string associated with the patset.
comment	<String>	Read-write	Any comments to preserve information about this patset or a pattern bound to this patset.
__count	<Double>	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 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/policypatset_pattern_binding

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"policypatset_pattern_binding":{
<b>      "name":<String_value>,
</b><b>      "String":<String_value>,
</b>      "index":<Double_value>,
      "charset":<String_value>,
      "comment":<String_value>
}}

<!--NeedCopy-->

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

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_binding/ name_value<String> ? args= String:<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 NetScaler-specific errors). The response payload provides details of the error

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_binding/ name_value<String>

Query-parameters:

filter

http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

pagination

http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_binding/ name_value<String> ? pagesize=#no;pageno=#no

Use this query-parameter to get the policypatset_pattern_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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "policypatset_pattern_binding": [ {
      "String":<String_value>,
      "feature":<String_value>,
      "builtin":<String[]_value>,
      "name":<String_value>,
      "charset":<String_value>,
      "index":<Double_value>,
      "comment":<String_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_binding

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_binding? bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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:

{  "policypatset_pattern_binding": [ {
      "String":<String_value>,
      "feature":<String_value>,
      "builtin":<String[]_value>,
      "name":<String_value>,
      "charset":<String_value>,
      "index":<Double_value>,
      "comment":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/policypatset_pattern_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 NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

policypatset_pattern_binding

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

policypatset_pattern_binding

Properties

Operations

add

delete

get

get (all)

count

In this article