ADC NITRO APIs

feoparameter

Configuration for FEO parameter resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
jpegqualitypercent <Double> Read-write The percentage value of a JPEG image quality to be reduced. Range: 0 - 100.

Default value: 75

Minimum value = 0

Maximum value = 100
cssinlinethressize <Double> Read-write Threshold value of the file size (in bytes) for converting external CSS files to inline CSS files.

Default value: 1024

Minimum value = 1

Maximum value = 2048
jsinlinethressize <Double> Read-write Threshold value of the file size (in bytes), for converting external JavaScript files to inline JavaScript files.

Default value: 1024

Minimum value = 1

Maximum value = 2048
imginlinethressize <Double> Read-write Maximum file size of an image (in bytes), for coverting linked images to inline images.

Default value: 1024

Minimum value = 1

Maximum value = 2048
builtin <String[]> Read-only Specify the builtin flags for - set feo param.

Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature <String> Read-only The feature to be checked while applying this config.

Operations

(click to see Properties )

  • UPDATE
  • UNSET
  • GET (ALL)

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/feoparameter HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"feoparameter":{
"jpegqualitypercent":<Double_value>,
"cssinlinethressize":<Double_value>,
"jsinlinethressize":<Double_value>,
"imginlinethressize":<Double_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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/feoparameter? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"feoparameter":{
"jpegqualitypercent":true,
"cssinlinethressize":true,
"jsinlinethressize":true,
"imginlinethressize":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

get (all)

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

{ "feoparameter": [ {
"jpegqualitypercent":<Double_value>,
"cssinlinethressize":<Double_value>,
"jsinlinethressize":<Double_value>,
"imginlinethressize":<Double_value>,
"builtin":<String[]_value>,
"feature":<String_value>
}]}

<!--NeedCopy-->
feoparameter