cloudngsparameter

Last published : Oct 30, 2026
Configuration for cloud ngsparameter resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
blockonallowedngstktprof <String> Read-write Enables blocking connections authenticated with a ticket createdby by an entity not whitelisted in allowedngstktprofile.
Default value: NO
Possible values = YES, NO
allowedudtversion <String> Read-write Enables the required UDT version to EDT connections in the CGS deployment.
Default value: V4
Possible values = V4, V5, V6, V7
csvserverticketingdecouple <String> Read-write Enables Decoupling CSVSERVER state from Ticketing Service state in the CGS deployment.
Default value: NO
Possible values = YES, NO
allowdtls12 <String> Read-write Enables DTLS1.2 for client connections on CGS.
Default value: NO
Possible values = YES, NO
wafprotection <String> Read-write Configure WAF protection for CGS deployment. The available options are:
* EDGE - Edge APIs are WAF protected.
* DEFAULT - NetScaler decides which endpoints have WAF protection enabled for CGS deployment.
* DISABLED - WAF protection is disabled.
Default value: DEFAULT
Possible values = DEFAULT, DISABLED, EDGE
_nextgenapiresource <String> Read-only .

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/cloudngsparameter HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"cloudngsparameter":{
"blockonallowedngstktprof":<String_value>,
"allowedudtversion":<String_value>,
"csvserverticketingdecouple":<String_value>,
"allowdtls12":<String_value>,
"wafprotection":<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/cloudngsparameter? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"cloudngsparameter":{
"blockonallowedngstktprof":true,
"allowedudtversion":true,
"csvserverticketingdecouple":true,
"allowdtls12":true,
"wafprotection":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/cloudngsparameter 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:
{ "cloudngsparameter": [ {
"blockonallowedngstktprof":<String_value>,
"allowedudtversion":<String_value>,
"csvserverticketingdecouple":<String_value>,
"allowdtls12":<String_value>,
"wafprotection":<String_value>,
"_nextgenapiresource":<String_value>
}]}