Product Documentation

feoaction

Sep 07, 2016

Configuration for Front end optimization action resource.

Properties (click to see Operations)

Name Data Type Permissions Description
name
<String>
Read-write
The name of the front end optimization action.
Minimum length = 1
pageextendcache
<Boolean>
Read-write
Extend the time period during which the browser can use the cached resource.
cachemaxage
<Double>
Read-write
Maxage for cache extension.
Default value: 30
Minimum value = 0
Maximum value = 360
imgshrinktoattrib
<Boolean>
Read-write
Shrink image dimensions as per the height and width attributes specified in the <img> tag.
imggiftopng
<Boolean>
Read-write
Convert GIF image formats to PNG formats.
imgtowebp
<Boolean>
Read-write
Convert JPEG, GIF, PNG image formats to WEBP format.
imgtojpegxr
<Boolean>
Read-write
Convert JPEG, GIF, PNG image formats to JXR format.
imginline
<Boolean>
Read-write
Inline images whose size is less than 2KB.
cssimginline
<Boolean>
Read-write
Inline small images (less than 2KB) referred within CSS files as background-URLs.
jpgoptimize
<Boolean>
Read-write
Remove non-image data such as comments from JPEG images.
imglazyload
<Boolean>
Read-write
Download images, only when the user scrolls the page to view them.
cssminify
<Boolean>
Read-write
Remove comments and whitespaces from CSSs.
cssinline
<Boolean>
Read-write
Inline CSS files, whose size is less than 2KB, within the main page.
csscombine
<Boolean>
Read-write
Combine one or more CSS files into one file.
convertimporttolink
<Boolean>
Read-write
Convert CSS import statements to HTML link tags.
jsminify
<Boolean>
Read-write
Remove comments and whitespaces from JavaScript.
jsinline
<Boolean>
Read-write
Convert linked JavaScript files (less than 2KB) to inline JavaScript files.
htmlminify
<Boolean>
Read-write
Remove comments and whitespaces from an HTML page.
cssmovetohead
<Boolean>
Read-write
Move any CSS file present within the body tag of an HTML page to the head tag.
jsmovetoend
<Boolean>
Read-write
Move any JavaScript present in the body tag to the end of the body tag.
domainsharding
<String>
Read-write
Domain name of the server.
dnsshards
<String[]>
Read-write
Set of domain names that replaces the parent domain.
clientsidemeasurements
<Boolean>
Read-write
Send AppFlow records about the web pages optimized by this action. The records provide FEO statistics, such as the number of HTTP requests that have been reduced for this page. You must enable the Appflow feature before enabling this parameter.
imgadddimensions
<Boolean>
Read-only
Add dimension attributes to images, if not specified within the <img> tag.
imgshrinkformobile
<Boolean>
Read-only
Serve smaller images for mobile users.
imgweaken
<Boolean>
Read-only
Reduce the image quality.
jpgprogressive
<Boolean>
Read-only
Convert JPEG image formats to progressive formats.
cssflattenimports
<Boolean>
Read-only
Replace CSS import statements with the file content.
jscombine
<Boolean>
Read-only
Combine one or more JavaScript files into one file.
htmlrmdefaultattribs
<Boolean>
Read-only
Remove default redundant attributes from an HTML file.
htmlrmattribquotes
<Boolean>
Read-only
Remove unnecessary quotes present within the HTML attributes.
htmltrimurls
<Boolean>
Read-only
Trim URLs.
hits
<Double>
Read-only
The number of times the action has been taken.
undefhits
<Double>
Read-only
Total number of undefined policy hits.
builtin
<String[]>
Read-only
Flag to determine if front end optimization action is built-in or not.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
__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/feoaction

HTTP Method: POST

Request Headers:

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

Request Payload:

{"feoaction":{
      "name":<String_value>,
      "pageextendcache":<Boolean_value>,
      "cachemaxage":<Double_value>,
      "imgshrinktoattrib":<Boolean_value>,
      "imggiftopng":<Boolean_value>,
      "imgtowebp":<Boolean_value>,
      "imgtojpegxr":<Boolean_value>,
      "imginline":<Boolean_value>,
      "cssimginline":<Boolean_value>,
      "jpgoptimize":<Boolean_value>,
      "imglazyload":<Boolean_value>,
      "cssminify":<Boolean_value>,
      "cssinline":<Boolean_value>,
      "csscombine":<Boolean_value>,
      "convertimporttolink":<Boolean_value>,
      "jsminify":<Boolean_value>,
      "jsinline":<Boolean_value>,
      "htmlminify":<Boolean_value>,
      "cssmovetohead":<Boolean_value>,
      "jsmovetoend":<Boolean_value>,
      "domainsharding":<String_value>,
      "dnsshards":<String[]_value>,
      "clientsidemeasurements":<Boolean_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

update

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{"feoaction":{
      "name":<String_value>,
      "pageextendcache":<Boolean_value>,
      "cachemaxage":<Double_value>,
      "imgshrinktoattrib":<Boolean_value>,
      "imggiftopng":<Boolean_value>,
      "imgtowebp":<Boolean_value>,
      "imgtojpegxr":<Boolean_value>,
      "imginline":<Boolean_value>,
      "cssimginline":<Boolean_value>,
      "jpgoptimize":<Boolean_value>,
      "imglazyload":<Boolean_value>,
      "cssminify":<Boolean_value>,
      "cssinline":<Boolean_value>,
      "csscombine":<Boolean_value>,
      "convertimporttolink":<Boolean_value>,
      "jsminify":<Boolean_value>,
      "jsinline":<Boolean_value>,
      "htmlminify":<Boolean_value>,
      "cssmovetohead":<Boolean_value>,
      "jsmovetoend":<Boolean_value>,
      "domainsharding":<String_value>,
      "dnsshards":<String[]_value>,
      "clientsidemeasurements":<Boolean_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/feoaction?action=unset

HTTP Method: POST

Request Headers:

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

Request Payload:

{"feoaction":{
      "name":<String_value>,
      "pageextendcache":true,
      "imgshrinktoattrib":true,
      "imggiftopng":true,
      "imgtowebp":true,
      "imgtojpegxr":true,
      "imginline":true,
      "cssimginline":true,
      "jpgoptimize":true,
      "imglazyload":true,
      "cssminify":true,
      "cssinline":true,
      "csscombine":true,
      "convertimporttolink":true,
      "jsminify":true,
      "jsinline":true,
      "htmlminify":true,
      "cssmovetohead":true,
      "jsmovetoend":true,
      "clientsidemeasurements":true,
      "domainsharding":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

delete

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

get (all)

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

Query-parameters:

attrs

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

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

view

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

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

pagination

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

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

{ "feoaction": [ {
      "name":<String_value>,
      "pageextendcache":<Boolean_value>,
      "cachemaxage":<Double_value>,
      "imgshrinktoattrib":<Boolean_value>,
      "imggiftopng":<Boolean_value>,
      "imgtowebp":<Boolean_value>,
      "imgtojpegxr":<Boolean_value>,
      "imgadddimensions":<Boolean_value>,
      "imgshrinkformobile":<Boolean_value>,
      "imgweaken":<Boolean_value>,
      "imginline":<Boolean_value>,
      "cssimginline":<Boolean_value>,
      "jpgoptimize":<Boolean_value>,
      "jpgprogressive":<Boolean_value>,
      "imglazyload":<Boolean_value>,
      "cssminify":<Boolean_value>,
      "cssinline":<Boolean_value>,
      "csscombine":<Boolean_value>,
      "cssflattenimports":<Boolean_value>,
      "convertimporttolink":<Boolean_value>,
      "jsminify":<Boolean_value>,
      "jsinline":<Boolean_value>,
      "jscombine":<Boolean_value>,
      "htmlminify":<Boolean_value>,
      "htmlrmdefaultattribs":<Boolean_value>,
      "htmlrmattribquotes":<Boolean_value>,
      "htmltrimurls":<Boolean_value>,
      "cssmovetohead":<Boolean_value>,
      "jsmovetoend":<Boolean_value>,
      "domainsharding":<String_value>,
      "dnsshards":<String[]_value>,
      "clientsidemeasurements":<Boolean_value>,
      "hits":<Double_value>,
      "undefhits":<Double_value>,
      "builtin":<String[]_value>
}]}

get

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

Query-parameters:

attrs

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

{ "feoaction": [ {
      "name":<String_value>,
      "pageextendcache":<Boolean_value>,
      "cachemaxage":<Double_value>,
      "imgshrinktoattrib":<Boolean_value>,
      "imggiftopng":<Boolean_value>,
      "imgtowebp":<Boolean_value>,
      "imgtojpegxr":<Boolean_value>,
      "imgadddimensions":<Boolean_value>,
      "imgshrinkformobile":<Boolean_value>,
      "imgweaken":<Boolean_value>,
      "imginline":<Boolean_value>,
      "cssimginline":<Boolean_value>,
      "jpgoptimize":<Boolean_value>,
      "jpgprogressive":<Boolean_value>,
      "imglazyload":<Boolean_value>,
      "cssminify":<Boolean_value>,
      "cssinline":<Boolean_value>,
      "csscombine":<Boolean_value>,
      "cssflattenimports":<Boolean_value>,
      "convertimporttolink":<Boolean_value>,
      "jsminify":<Boolean_value>,
      "jsinline":<Boolean_value>,
      "jscombine":<Boolean_value>,
      "htmlminify":<Boolean_value>,
      "htmlrmdefaultattribs":<Boolean_value>,
      "htmlrmattribquotes":<Boolean_value>,
      "htmltrimurls":<Boolean_value>,
      "cssmovetohead":<Boolean_value>,
      "jsmovetoend":<Boolean_value>,
      "domainsharding":<String_value>,
      "dnsshards":<String[]_value>,
      "clientsidemeasurements":<Boolean_value>,
      "hits":<Double_value>,
      "undefhits":<Double_value>,
      "builtin":<String[]_value>
}]}

count

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

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