ADC NITRO APIs

nshttpparam

August 17, 2023

Contributed by:

Configuration for HTTP parameter resource.

Properties

(click to see Operations )

Name	Data Type	Permissions	Description
dropinvalreqs		Read-write	Drop invalid HTTP requests or responses. Default value: OFF Possible values = ON, OFF
markhttp09inval		Read-write	Mark HTTP/0.9 requests as invalid. Default value: OFF Possible values = ON, OFF
markconnreqinval		Read-write	Mark CONNECT requests as invalid. Default value: OFF Possible values = ON, OFF
insnssrvrhdr		Read-write	Enable or disable Citrix ADC server header insertion for Citrix ADC generated HTTP responses. Default value: OFF Possible values = ON, OFF
nssrvrhdr		Read-write	The server header value to be inserted. If no explicit header is specified then NSBUILD.RELEASE is used as default server header. Minimum length = 1
logerrresp		Read-write	Server header value to be inserted. Default value: ON Possible values = ON, OFF
conmultiplex		Read-write	Reuse server connections for requests from more than one client connections. Default value: ENABLED Possible values = ENABLED, DISABLED
maxreusepool		Read-write	Maximum limit on the number of connections, from the Citrix ADC to a particular server that are kept in the reuse pool. This setting is helpful for optimal memory utilization and for reducing the idle connections to the server just after the peak time. Default value: 0 Minimum value = 0 Maximum value = 360000
http2serverside		Read-write	Enable/Disable HTTP/2 on server side. Default value: OFF Possible values = ON, OFF
ignoreconnectcodingscheme		Read-write	Ignore Coding scheme in CONNECT request. Default value: DISABLED Possible values = ENABLED, DISABLED
builtin	<String[]>	Read-only	Flag to determine if the http param is built-in or not. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature		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/nshttpparam

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nshttpparam":{
      "dropinvalreqs":<String_value>,
      "markhttp09inval":<String_value>,
      "markconnreqinval":<String_value>,
      "insnssrvrhdr":<String_value>,
      "nssrvrhdr":<String_value>,
      "logerrresp":<String_value>,
      "conmultiplex":<String_value>,
      "maxreusepool":<Double_value>,
      "http2serverside":<String_value>,
      "ignoreconnectcodingscheme":<String_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/nshttpparam? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nshttpparam":{
      "dropinvalreqs":true,
      "markhttp09inval":true,
      "markconnreqinval":true,
      "insnssrvrhdr":true,
      "nssrvrhdr":true,
      "logerrresp":true,
      "conmultiplex":true,
      "maxreusepool":true,
      "http2serverside":true,
      "ignoreconnectcodingscheme":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/nshttpparam

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:

{ "nshttpparam": [ {
      "dropinvalreqs":<String_value>,
      "markhttp09inval":<String_value>,
      "markconnreqinval":<String_value>,
      "insnssrvrhdr":<String_value>,
      "nssrvrhdr":<String_value>,
      "logerrresp":<String_value>,
      "conmultiplex":<String_value>,
      "maxreusepool":<Double_value>,
      "http2serverside":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "ignoreconnectcodingscheme":<String_value>
}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

nshttpparam

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

nshttpparam

Properties

Operations

update

unset

get (all)

In this article