Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

appfwprofile_jsondosurl_binding

May 23, 2024
Contributed by: 
C

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

Properties

(click to see Operations )

Name Data Type Permissions Description
jsonmaxarraylengthcheck Read-write State if JSON Max array value count check is ON or OFF.

Possible values = ON, OFF
jsonmaxdocumentlengthcheck Read-write State if JSON Max document length check is ON or OFF.

Possible values = ON, OFF
state Read-write Enabled.

Possible values = ENABLED, DISABLED
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
jsonmaxcontainerdepth Read-write Maximum allowed nesting depth of JSON document. JSON allows one to nest the containers (object and array) in any order to any depth. This check protects against documents that have excessive depth of hierarchy.

Default value: 5

Minimum value = 0

Maximum value = 127
jsonmaxobjectkeylengthcheck Read-write State if JSON Max object key length check is ON or OFF.

Possible values = ON, OFF
jsondosurl Read-write The URL on which we need to enforce the specified JSON denial-of-service (JSONDoS) attack protections. An JSON DoS configuration consists of the following items
  • URL. PCRE-format regular expression for the URL.
  • Maximum-document-length-check toggle. ON to enable this check, OFF to disable it.
  • Maximum document length. Positive integer representing the maximum length of the JSON document.
  • Maximum-container-depth-check toggle. ON to enable, OFF to disable.
  • Maximum container depth. Positive integer representing the maximum container depth of the JSON document.
  • Maximum-object-key-count-check toggle. ON to enable, OFF to disable.
  • Maximum object key count. Positive integer representing the maximum allowed number of keys in any of the JSON object.
  • Maximum-object-key-length-check toggle. ON to enable, OFF to disable.
  • Maximum object key length. Positive integer representing the maximum allowed length of key in any of the JSON object.
  • Maximum-array-value-count-check toggle. ON to enable, OFF to disable.
  • Maximum array value count. Positive integer representing the maximum allowed number of values in any of the JSON array.
  • Maximum-string-length-check toggle. ON to enable, OFF to disable.
  • Maximum string length. Positive integer representing the maximum length of string in JSON. Minimum length = 1 Maximum length = 2047
    		•
    alertonly Read-write Send SNMP alert?.

    Possible values = ON, OFF
    jsonmaxarraylength Read-write Maximum array length in the any of JSON object. This check protects against arrays having large lengths.

    Default value: 10000

    Minimum value = 0

    Maximum value = 2147483647
    jsonmaxdocumentlength Read-write Maximum document length of JSON document, in bytes.

    Default value: 20000000

    Minimum value = 0

    Maximum value = 2147483647
    jsonmaxobjectkeycountcheck Read-write State if JSON Max object key count check is ON or OFF.

    Possible values = ON, OFF
    jsonmaxobjectkeylength Read-write Maximum key length in the any of JSON object. This check protects against objects that have large keys.

    Default value: 128

    Minimum value = 0

    Maximum value = 2147483647
    jsonmaxobjectkeycount Read-write Maximum key count in the any of JSON object. This check protects against objects that have large number of keys.

    Default value: 10000

    Minimum value = 0

    Maximum value = 2147483647
    ruletype Read-write Specifies rule type of binding.

    Possible values = ALLOW, DENY
    jsonmaxstringlengthcheck Read-write State if JSON Max string value count check is ON or OFF.

    Possible values = ON, OFF
    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.
    jsonmaxcontainerdepthcheck Read-write State if JSON Max depth check is ON or OFF.

    Possible values = ON, OFF
    jsonmaxstringlength Read-write Maximum string length in the JSON. This check protects against strings that have large length.

    Default value: 1000000

    Minimum value = 0

    Maximum value = 2147483647
    __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_jsondosurl_binding HTTP Method: PUT

    Request Headers:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

    Content-Type:application/json

    Request Payload: 

    {
"appfwprofile_jsondosurl_binding":{
<b>"name":<String_value>,
</b>"comment":<String_value>,
"state":<String_value>,
"jsondosurl":<String_value>,
"jsonmaxcontainerdepthcheck":<String_value>,
"jsonmaxcontainerdepth":<Double_value>,
"jsonmaxdocumentlengthcheck":<String_value>,
"jsonmaxdocumentlength":<Double_value>,
"jsonmaxobjectkeycountcheck":<String_value>,
"jsonmaxobjectkeycount":<Double_value>,
"jsonmaxobjectkeylengthcheck":<String_value>,
"jsonmaxobjectkeylength":<Double_value>,
"jsonmaxarraylengthcheck":<String_value>,
"jsonmaxarraylength":<Double_value>,
"jsonmaxstringlengthcheck":<String_value>,
"jsonmaxstringlength":<Double_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_jsondosurl_binding/ name_value<String> Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsondosurl_binding/ name_value<String> ? args=jsondosurl: <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_jsondosurl_binding/ name_value<String> Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsondosurl_binding/ name_value<String> ? filter=property-name1:property-value1,property-name2:property-value2

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

    Use this query-parameter to get the appfwprofile_jsondosurl_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_jsondosurl_binding": [ {
"jsonmaxarraylengthcheck":<String_value>,
"jsonmaxdocumentlengthcheck":<String_value>,
"state":<String_value>,
"resourceid":<String_value>,
"name":<String_value>,
"jsonmaxcontainerdepth":<Double_value>,
"jsonmaxobjectkeylengthcheck":<String_value>,
"jsondosurl":<String_value>,
"alertonly":<String_value>,
"jsonmaxarraylength":<Double_value>,
"jsonmaxdocumentlength":<Double_value>,
"jsonmaxobjectkeycountcheck":<String_value>,
"jsonmaxobjectkeylength":<Double_value>,
"jsonmaxobjectkeycount":<Double_value>,
"ruletype":<String_value>,
"jsonmaxstringlengthcheck":<String_value>,
"isautodeployed":<String_value>,
"comment":<String_value>,
"jsonmaxcontainerdepthcheck":<String_value>,
"jsonmaxstringlength":<Double_value>
}]}

<!--NeedCopy-->

    get (all)

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsondosurl_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_jsondosurl_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_jsondosurl_binding": [ {
"jsonmaxarraylengthcheck":<String_value>,
"jsonmaxdocumentlengthcheck":<String_value>,
"state":<String_value>,
"resourceid":<String_value>,
"name":<String_value>,
"jsonmaxcontainerdepth":<Double_value>,
"jsonmaxobjectkeylengthcheck":<String_value>,
"jsondosurl":<String_value>,
"alertonly":<String_value>,
"jsonmaxarraylength":<Double_value>,
"jsonmaxdocumentlength":<Double_value>,
"jsonmaxobjectkeycountcheck":<String_value>,
"jsonmaxobjectkeylength":<Double_value>,
"jsonmaxobjectkeycount":<Double_value>,
"ruletype":<String_value>,
"jsonmaxstringlengthcheck":<String_value>,
"isautodeployed":<String_value>,
"comment":<String_value>,
"jsonmaxcontainerdepthcheck":<String_value>,
"jsonmaxstringlength":<Double_value>
}]}

<!--NeedCopy-->

    count

    URL: http:// <netscaler-ip-address> /nitro/v1/config/appfwprofile_jsondosurl_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_jsondosurl_binding": [ { "__count": "#no"} ] }

<!--NeedCopy-->
    appfwprofile_jsondosurl_binding
    May 23, 2024
    Contributed by: 
    C
    May 23, 2024
    Contributed by: 
    C

    In this article

    Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
    © 1999- Cloud Software Group, Inc. All rights reserved.