ADC NITRO APIs

appfwprofile_jsoncmdurl_binding

May 23, 2024

Contributed by:

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

Properties

(click to see Operations )

Name	Permissions	Description
state	Read-write	Enabled. Possible values = ENABLED, DISABLED
jsoncmdurl	Read-write	A regular expression that designates a URL on the Json CMD URL list for which Command injection violations are relaxed. Enclose URLs in double quotes to ensure preservation of any embedded spaces or non-alphanumeric characters. Minimum length = 1 Maximum length = 2047
resourceid	Read-write	A “id” that identifies the rule.
name	Read-write	Name of the profile to which to bind an exemption or rule. Minimum length = 1
isvalueregex_json_cmd	Read-write	Is the JSON CMD key value a regular expression?. Possible values = REGEX, NOTREGEX
alertonly	Read-write	Send SNMP alert?. Possible values = ON, OFF
ruletype	Read-write	Specifies rule type of binding. Possible values = ALLOW, DENY
as_value_type_json_cmd	Read-write	Type of the relaxed JSON CMD key value. Possible values = Keyword, SpecialString
keyname_json_cmd	Read-write	An expression that designates a keyname on the JSON CMD URL for which Command injection violations are relaxed. Minimum length = 1
isautodeployed	Read-write	Is the rule auto deployed by dynamic profile ?. Possible values = AUTODEPLOYED, NOTAUTODEPLOYED
comment	Read-write	Any comments about the purpose of profile, or other useful information about the profile.
as_value_expr_json_cmd	Read-write	The JSON CMD key value expression.
iskeyregex_json_cmd	Read-write	Is the key name a regular expression?. Possible values = REGEX, NOTREGEX
__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 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/appfwprofile_jsoncmdurl_binding HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{
"appfwprofile_jsoncmdurl_binding":{
<b>"name":<String_value>,
</b>"comment":<String_value>,
"state":<String_value>,
"jsoncmdurl":<String_value>,
"keyname_json_cmd":<String_value>,
"iskeyregex_json_cmd":<String_value>,
"as_value_type_json_cmd":<String_value>,
"as_value_expr_json_cmd":<String_value>,
"isvalueregex_json_cmd":<String_value>,
"isautodeployed":<String_value>,
"resourceid":<String_value>,
"ruletype":<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/appfwprofile_jsoncmdurl_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsoncmdurl_binding/ name_value<String> ? args=jsoncmdurl: <String_value> ,keyname_json_cmd: <String_value> ,as_value_type_json_cmd: <String_value> ,as_value_expr_json_cmd: <String_value> ,ruletype: <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/appfwprofile_jsoncmdurl_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsoncmdurl_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

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

{  "appfwprofile_jsoncmdurl_binding": [ {
"state":<String_value>,
"jsoncmdurl":<String_value>,
"resourceid":<String_value>,
"name":<String_value>,
"isvalueregex_json_cmd":<String_value>,
"alertonly":<String_value>,
"ruletype":<String_value>,
"as_value_type_json_cmd":<String_value>,
"keyname_json_cmd":<String_value>,
"isautodeployed":<String_value>,
"comment":<String_value>,
"as_value_expr_json_cmd":<String_value>,
"iskeyregex_json_cmd":<String_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsoncmdurl_binding HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsoncmdurl_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:

{  "appfwprofile_jsoncmdurl_binding": [ {
"state":<String_value>,
"jsoncmdurl":<String_value>,
"resourceid":<String_value>,
"name":<String_value>,
"isvalueregex_json_cmd":<String_value>,
"alertonly":<String_value>,
"ruletype":<String_value>,
"as_value_type_json_cmd":<String_value>,
"keyname_json_cmd":<String_value>,
"isautodeployed":<String_value>,
"comment":<String_value>,
"as_value_expr_json_cmd":<String_value>,
"iskeyregex_json_cmd":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsoncmdurl_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:

{"appfwprofile_jsoncmdurl_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

appfwprofile_jsoncmdurl_binding

May 23, 2024

Contributed by:

May 23, 2024

Contributed by:

appfwprofile_jsoncmdurl_binding

Properties

Operations

add

delete

get

get (all)

count

In this article