vpnglobal_sslcertkey_binding

Last published : Oct 30, 2026
Binding object showing the sslcertkey that can be bound to vpnglobal.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
gotopriorityexpression <String> Read-write Applicable only to advance vpn session policy. An expression or other value specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
certkeyname <String> Read-write SSL certkey to use in signing tokens. Only RSA cert key is allowed.
ocspcheck <String> Read-write The state of the OCSP check parameter (Mandatory/Optional).
Possible values = Mandatory, Optional
crlcheck <String> Read-write The state of the CRL check parameter (Mandatory/Optional).
Possible values = Mandatory, Optional
userdataencryptionkey <String> Read-write Certificate to be used for encrypting user data like KB Question and Answers, Alternate Email Address, etc.
cacert <String> Read-write The name of the CA certificate binding.
__count <Double> Read-write count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • GET
  • COUNT
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

add

URL: http:// <netscaler-ip-address /nitro/v1/config/vpnglobal_sslcertkey_binding HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{
"vpnglobal_sslcertkey_binding":{
"gotopriorityexpression":<String_value>,
"certkeyname":<String_value>,
"userdataencryptionkey":<String_value>,
"cacert":<String_value>,
"crlcheck":<String_value>,
"ocspcheck":<String_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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_sslcertkey_binding Query-parameters: args http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_sslcertkey_binding? args=certkeyname: <String_value> ,userdataencryptionkey: <String_value> ,cacert: <String_value>
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

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_sslcertkey_binding Query-parameters: filter http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_sslcertkey_binding? filter=property-name1:property-value1,property-name2:property-value2
Use this query-parameter to get the filtered set of vpnglobal_sslcertkey_binding resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
pagination http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_sslcertkey_binding? pagesize=#no;pageno=#no
Use this query-parameter to get the vpnglobal_sslcertkey_binding 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 Header:
Content-Type:application/json
Response Payload:
{  "vpnglobal_sslcertkey_binding": [ {
"gotopriorityexpression":<String_value>,
"certkeyname":<String_value>,
"ocspcheck":<String_value>,
"crlcheck":<String_value>,
"userdataencryptionkey":<String_value>,
"cacert":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_sslcertkey_binding? 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 Header:
Content-Type:application/json
Response Payload:
{ "vpnglobal_sslcertkey_binding": [ { "__count": "#no"} ] }