contentinspectionwasmprofile
Configuration for WASM profile resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name | <String> | Read-write | Name of CI WASM profile.
Minimum length = 1
Maximum length = 127
|
| timeout | <Integer> | Read-write | Timeout (in milliseconds) for the connection with the CI WASM agent.
Default value: 1000
Minimum value = 0
Maximum value = 86400000
|
| timeoutaction | <String> | Read-write | Timeout action for the connection with the CI agent. Either the original request can be bypassed i.e. request/response is forwarded to the endpoint or the transaction is dropped/reset.
Default value: DROP
Possible values = BYPASS, DROP, RESET
|
| maxbodylen | <Integer> | Read-write | Max data size (in KB) that will be sent to the CI Agent. Default is 16KB. Maximum value that can be configured is 32KB.
Default value: 16
Minimum value = 0
Maximum value = 32
|
| anomalousdatasize | <Integer> | Read-write | Transaction data size (in KB) greater than which a transaction is considered as anomalous. Default is 512KB.
Default value: 512
Minimum value = 0
Maximum value = 512
|
| anomalousttfbtime | <Integer> | Read-write | Transaction time (in milliseconds) above which a transaction is considered as anomalous. Default is 1 seconds.
Default value: 1000
Minimum value = 0
Maximum value = 3600000
|
| wasmmodule | <String> | Read-write | Name of the WASM Module.
Minimum length = 1
Maximum length = 127
|
| _nextgenapiresource | <String> | Read-only | . |
| __count | <Double> | Read-only | count parameter |
Operations
(click to see Properties )
- ADD
- DELETE
- UPDATE
- UNSET
- GET (ALL)
- GET
- 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=yesIf 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/contentinspectionwasmprofile HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"contentinspectionwasmprofile":{
<b>"name":<String_value>,
</b>"timeout":<Integer_value>,
"timeoutaction":<String_value>,
"maxbodylen":<Integer_value>,
"anomalousdatasize":<Integer_value>,
"anomalousttfbtime":<Integer_value>,
<b>"wasmmodule":<String_value>
</b>}}
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/contentinspectionwasmprofile/ name_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 NetScaler-specific errors). The response payload provides details of the error
update
URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"contentinspectionwasmprofile":{
<b>"name":<String_value>,
</b>"timeout":<Integer_value>,
"timeoutaction":<String_value>,
"maxbodylen":<Integer_value>,
"anomalousdatasize":<Integer_value>,
"anomalousttfbtime":<Integer_value>,
"wasmmodule":<String_value>
}}
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
unset
URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"contentinspectionwasmprofile":{
<b>"name":<String_value>,
</b>"timeout":true,
"timeoutaction":true,
"maxbodylen":true,
"anomalousdatasize":true,
"anomalousttfbtime":true
}}
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 (all)
URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile? 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/contentinspectionwasmprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of contentinspectionwasmprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile? view=summary
Use this query-parameter to get the summary output of contentinspectionwasmprofile 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/contentinspectionwasmprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the contentinspectionwasmprofile 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:
{ "contentinspectionwasmprofile": [ {
"name":<String_value>,
"timeout":<Integer_value>,
"timeoutaction":<String_value>,
"maxbodylen":<Integer_value>,
"anomalousdatasize":<Integer_value>,
"anomalousttfbtime":<Integer_value>,
"wasmmodule":<String_value>,
"_nextgenapiresource":<String_value>
}]}
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of contentinspectionwasmprofile resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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:
{ "contentinspectionwasmprofile": [ {
"name":<String_value>,
"timeout":<Integer_value>,
"timeoutaction":<String_value>,
"maxbodylen":<Integer_value>,
"anomalousdatasize":<Integer_value>,
"anomalousttfbtime":<Integer_value>,
"wasmmodule":<String_value>,
"_nextgenapiresource":<String_value>
}]}
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/contentinspectionwasmprofile? 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:
{ "contentinspectionwasmprofile": [ { "__count": "#no"} ] }