Product Documentation

appflowaction

Sep 01, 2016

Configuration for AppFlow action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
Name for the action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow action" or 'my appflow action').
collectors
<String[]>
Read-write
Name(s) of collector(s) to be associated with the AppFlow action.
Minimum length = 1
clientsidemeasurements
<String>
Read-write
On enabling this option, the NetScaler will collect the time required to load and render the mainpage on the client.
Default value: DISABLED
Possible values = ENABLED, DISABLED
pagetracking
<String>
Read-write
On enabling this option, the NetScaler will start tracking the page for waterfall chart by inserting a NS_ESNS cookie in the response.
Default value: DISABLED
Possible values = ENABLED, DISABLED
webinsight
<String>
Read-write
On enabling this option, the netscaler will send the webinsight records to the configured collectors.
Default value: ENABLED
Possible values = ENABLED, DISABLED
securityinsight
<String>
Read-write
On enabling this option, the netscaler will send the security insight records to the configured collectors.
Default value: DISABLED
Possible values = ENABLED, DISABLED
comment
<String>
Read-write
Any comments about this action. In the CLI, if including spaces between words, enclose the comment in quotation marks. (The quotation marks are not required in the configuration utility.).
Maximum length = 256
newname
<String>
Read-write
New name for the AppFlow action. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at
(@), equals (=), and hyphen (-) characters.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my appflow action" or 'my appflow action').
Minimum length = 1
hits
<Double>
Read-only
The number of times the action has been taken.
referencecount
<Double>
Read-only
The number of references to the action.
description
<String>
Read-only
Description of the action.
__count
<Double>
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 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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add

URL: http://<netscaler-ip-address>/nitro/v1/config/appflowaction

HTTP Method: POST

Request Headers:

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

Request Payload:

{"appflowaction":{
      "name":<String_value>,
      "collectors":<String[]_value>,
      "clientsidemeasurements":<String_value>,
      "pagetracking":<String_value>,
      "webinsight":<String_value>,
      "securityinsight":<String_value>,
      "comment":<String_value>
}}

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/appflowaction/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/appflowaction

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"appflowaction":{
      "name":<String_value>,
      "collectors":<String[]_value>,
      "clientsidemeasurements":<String_value>,
      "comment":<String_value>,
      "pagetracking":<String_value>,
      "webinsight":<String_value>,
      "securityinsight":<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/appflowaction?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"appflowaction":{
      "name":<String_value>,
      "clientsidemeasurements":true,
      "comment":true,
      "pagetracking":true,
      "webinsight":true,
      "securityinsight":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

rename

URL: http://<netscaler-ip-address>/nitro/v1/config/appflowaction?action=rename

HTTP Method: POST

Request Headers:

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

Request Payload:

{"appflowaction":{
      "name":<String_value>,
      "newname":<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

get (all)

URL: http://<netscaler-ip-address>/nitro/v1/config/appflowaction

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/appflowaction?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/appflowaction?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

http://<netscaler-ip-address>/nitro/v1/config/appflowaction?pagesize=#no&pageno=#no

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

Content-Type:application/json

Response Payload:

{ "appflowaction": [ {
      "name":<String_value>,
      "hits":<Double_value>,
      "collectors":<String[]_value>,
      "clientsidemeasurements":<String_value>,
      "pagetracking":<String_value>,
      "webinsight":<String_value>,
      "securityinsight":<String_value>,
      "referencecount":<Double_value>,
      "description":<String_value>,
      "comment":<String_value>
}]}

get

URL: http://<netscaler-ip-address>/nitro/v1/config/appflowaction/name_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/appflowaction/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/appflowaction/name_value<String>?view=summary

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 Headers:

Content-Type:application/json

Response Payload:

{ "appflowaction": [ {
      "name":<String_value>,
      "hits":<Double_value>,
      "collectors":<String[]_value>,
      "clientsidemeasurements":<String_value>,
      "pagetracking":<String_value>,
      "webinsight":<String_value>,
      "securityinsight":<String_value>,
      "referencecount":<Double_value>,
      "description":<String_value>,
      "comment":<String_value>
}]}

count

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

Content-Type:application/json

Response Payload:

{ "appflowaction": [ { "__count": "#no"} ] }