ADC NITRO APIs

appfwconfidfield

Configuration for configured confidential form fields resource.

Properties

(click to see Operations )

Name Data Type 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 )

    • ADD
    • DELETE
    • UPDATE
    • UNSET
    • 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

    unset

    URL: http:// <netscaler-ip-address> /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: 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

    delete

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwconfidfield/ fieldname_value<String> Query-parameters: args= url:<String_value>

    </b></b>

    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

    update

    URL: http:// <netscaler-ip-address> /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: 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

    add

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

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwconfidfield Query-parameters: attrs http:// <netscaler-ip-address> /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:// <netscaler-ip-address> /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 NetScaler.Filtering can be done on any of the properties of the resource.

    view http:// <netscaler-ip-address> /nitro/v1/config/appfwconfidfield? view=summary

    Use this query-parameter to get the summary output of appfwconfidfield resources configured on NetScaler.

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

    pagination http:// <netscaler-ip-address> /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: 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:

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

    count

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

    { "appfwconfidfield": [ { "__count": "#no"} ] }
    
    <!--NeedCopy-->
    
    appfwconfidfield