Citrix ADC 12.1 NITRO API Reference

appfwconfidfield

August 17, 2023

Contributed by:

Configuration for configured confidential form fields resource.

Properties

(click to see Operations)

Name	Permissions	Description
fieldname	Read-write	Name of the form field to designate as confidential. Minimum length = 1
url	Read-write	URL of the web page that contains the web form. Minimum length = 1
isregex	Read-write	Method of specifying the form field name. Available settings function as follows: * REGEX. Form field is a regular expression. * NOTREGEX. Form field is a literal string. Default value: NOTREGEX Possible values = REGEX, NOTREGEX
comment	Read-write	Any comments to preserve information about the form field designation.
state	Read-write	Enable or disable the confidential field designation. Default value: ENABLED Possible values = ENABLED, DISABLED
__count	Read-only	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/appfwconfidfield

HTTP Method:POST

Request Headers:

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

Request Payload:

{"appfwconfidfield":{
<b>"fieldname":<String_value>,
</b><b>"url":<String_value>,
</b>"isregex":<String_value>,
"comment":<String_value>,
"state":<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 Citrix ADC specific errors). The response payload provides details of the error

delete

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

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

update

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

HTTP Method:PUT

Request Headers:

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

Request Payload:

{"appfwconfidfield":{
<b>"fieldname":<String_value>,
</b><b>"url":<String_value>,
</b>"comment":<String_value>,
"isregex":<String_value>,
"state":<String_value>
}}

<!--NeedCopy-->

Response:

unset

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwconfidfield?action=unset

HTTP Method:POST

Request Headers:

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

Request Payload:

{"appfwconfidfield":{
<b>"fieldname":<String_value>,
</b><b>"url":<String_value>,
</b>"comment":true,
"isregex":true,
"state":true
}}

<!--NeedCopy-->

Response:

get (all)

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

Query-parameters:

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwconfidfield?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwconfidfield?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwconfidfield?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

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

Use this query-parameter to get the appfwconfidfield resources in chunks.

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

{ "appfwconfidfield": [ {
"fieldname":<String_value>,
"url":<String_value>,
"isregex":<String_value>,
"comment":<String_value>,
"state":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/appfwconfidfield?count=yes

HTTP Method:GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Accept:application/json

Response:

Content-Type:application/json

Response Payload:

{ "appfwconfidfield": [ { "__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

appfwconfidfield

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

appfwconfidfield

Properties

Operations

add

delete

update

unset

get (all)

count

In this article