Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

sslzerotouchparam

June 18, 2026
Contributed by: 
C

Configuration for Zerotouch params resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ocspcachetimeout Read-write Timeout(in minutes) for caching the OCSP response.
Default value: 1
Minimum value = 1
Maximum value = 43200
ocspbatchingdepth Read-write Number of certificates to batch together into one OCSP request. Batching avoids overloading the OCSP responder. A value of 1 signifies that each request is queried independently. For a value greater than 1, specify a timeout (batching delay) to avoid inordinately delaying the processing of a single certificate.
Minimum value = 1
Maximum value = 8
ocspbatchingdelay Read-write Maximum time, in milliseconds, to wait to accumulate OCSP requests to batch. Does not apply if the Batching Depth is 1.
Minimum value = 1
Maximum value = 10000
ocspresptimeout Read-write Time, in milliseconds, to wait for an OCSP response. When this time elapses, an error message appears or the transaction is forwarded, depending on the settings on the virtual server. Includes Batching Delay time.
Minimum value = 100
Maximum value = 120000
ocspurlresolvetimeout Read-write Time, in milliseconds, to wait for an OCSP URL Resolution. When this time elapses, an error message appears or the transaction is forwarded, depending on the settings on the virtual server.
Minimum value = 100
Maximum value = 2000
ocsptrustresponder Read-write If trustResponder is set to YES, signature verification will be skipped for the OCSP response.
Possible values = YES, NO
ocspproducedattimeskew Read-write Time, in seconds, for which the Citrix ADC waits before considering the response as invalid. The response is considered invalid if the Produced At time stamp in the OCSP response exceeds or precedes the current Citrix ADC clock time by the amount of time specified.
Default value: 300
Minimum value = 0
Maximum value = 86400
ocspusenonce Read-write Enable the OCSP nonce extension, which is designed to prevent replay attacks.
Default value: ENABLED
Possible values = ENABLED, DISABLED
ocsphttpmethod Read-write HTTP method used to send ocsp request. POST is the default httpmethod. If request length is > 255, POST wil be used even if GET is set as httpMethod.
Default value: POST
Possible values = GET, POST
zerotouch Read-only Flag to enable or disable the zero touch certificate management.
Default value: DISABLED
Possible values = ENABLED, DISABLED
remoteserverip Read-only Certfetcher daemon connects to this IP to fetch certificates and keys.
Minimum length = 1
keyfilename Read-only Name of the private key file which ADM creates on NetScaler while enabling zero touch certificate management.
Minimum length = 1
Maximum length = 63
passphrase Read-only Password to the private key file.
Minimum length = 3
admconnectivitystatus Read-only Status of the request sent by the certfetcher daemon to the remote server.
httpstatuscode Read-only Status code received by the certfetcher daemon from the remote server.
requesttype Read-only Type of the request sent by the certfetcher daemon to the remote server.
requesttimestamp Read-only Timestamp at which request was sent by the certfetcher daemon to the remote server.
nextrequesttime Read-only Timestamp at which next polling request will be sent by the certfetcher daemon to the remote server.
_nextgenapiresource 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/sslzerotouchparam HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"sslzerotouchparam":{
"ocspcachetimeout":<Integer_value>,
"ocspbatchingdepth":<Integer_value>,
"ocspbatchingdelay":<Integer_value>,
"ocspresptimeout":<Integer_value>,
"ocspurlresolvetimeout":<Integer_value>,
"ocsptrustresponder":<String_value>,
"ocspproducedattimeskew":<Integer_value>,
"ocspusenonce":<String_value>,
"ocsphttpmethod":<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/sslzerotouchparam? action=unset HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 

{"sslzerotouchparam":{
"ocspcachetimeout":true,
"ocspbatchingdepth":true,
"ocspbatchingdelay":true,
"ocspresptimeout":true,
"ocspurlresolvetimeout":true,
"ocsptrustresponder":true,
"ocspproducedattimeskew":true,
"ocspusenonce":true,
"ocsphttpmethod":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/sslzerotouchparam 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: 

{ "sslzerotouchparam": [ {
"zerotouch":<String_value>,
"remoteserverip":<String_value>,
"keyfilename":<String_value>,
"passphrase":<String_value>,
"admconnectivitystatus":<String_value>,
"httpstatuscode":<String_value>,
"requesttype":<String_value>,
"requesttimestamp":<String_value>,
"nextrequesttime":<String_value>,
"ocspcachetimeout":<Integer_value>,
"ocspbatchingdepth":<Integer_value>,
"ocspbatchingdelay":<Integer_value>,
"ocspresptimeout":<Integer_value>,
"ocspurlresolvetimeout":<Integer_value>,
"ocsptrustresponder":<String_value>,
"ocspproducedattimeskew":<Integer_value>,
"ocspusenonce":<String_value>,
"ocsphttpmethod":<String_value>,
"_nextgenapiresource":<String_value>
}]}

<!--NeedCopy-->
sslzerotouchparam
June 18, 2026
Contributed by: 
C
June 18, 2026
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.