Download full document:

sslcertkey

Configuration for certificate key resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
certkey<String>Read-writeName for the certificate and private-key pair. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the certificate-key pair is created.

The following requirement applies only to the NetScaler CLI:
If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my cert" or 'my cert').
Minimum length = 1
cert<String>Read-writeName of and, optionally, path to the X509 certificate file that is used to form the certificate-key pair. The certificate file should be present on the appliance's hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.
Minimum length = 1
key<String>Read-writeName of and, optionally, path to the private-key file that is used to form the certificate-key pair. The certificate file should be present on the appliance's hard-disk drive or solid-state drive. Storing a certificate in any location other than the default might cause inconsistency in a high availability setup. /nsconfig/ssl/ is the default path.
Minimum length = 1
password<Boolean>Read-writePassphrase that was used to encrypt the private-key. Use this option to load encrypted private-keys in PEM format.
fipskey<String>Read-writeName of the FIPS key that was created inside the Hardware Security Module (HSM) of a FIPS appliance, or a key that was imported into the HSM.
Minimum length = 1
hsmkey<String>Read-writeName of the HSM key that was created in the External Hardware Security Module (HSM) of a FIPS appliance.
Minimum length = 1
inform<String>Read-writeInput format of the certificate and the private-key files. The three formats supported by the appliance are:
PEM - Privacy Enhanced Mail
DER - Distinguished Encoding Rule
PFX - Personal Information Exchange.
Default value: PEM
Possible values = DER, PEM, PFX
passplain<String>Read-writePass phrase used to encrypt the private-key. Required when adding an encrypted private-key in PEM format.
Minimum length = 1
expirymonitor<String>Read-writeIssue an alert when the certificate is about to expire.
Possible values = ENABLED, DISABLED
notificationperiod<Double>Read-writeTime, in number of days, before certificate expiration, at which to generate an alert that the certificate is about to expire.
Minimum value = 10
Maximum value = 100
bundle<String>Read-writeParse the certificate chain as a single file after linking the server certificate to its issuer's certificate within the file.
Default value: NO
Possible values = YES, NO
linkcertkeyname<String>Read-writeName of the Certificate Authority certificate-key pair to which to link a certificate-key pair.
Minimum length = 1
nodomaincheck<Boolean>Read-writeOverride the check for matching domain names during a certificate update operation.
signaturealg<String>Read-onlySignature algorithm.
certificatetype<String[]>Read-onlySpecifies whether the certificate is of type root-CA, intermediate-CA, server, client, or client and server.
Possible values = ROOT_CERT, INTM_CERT, CLNT_CERT, SRVR_CERT, UNKNOWN_CERT
serial<String>Read-onlySerial number.
issuer<String>Read-onlyIssuer name.
clientcertnotbefore<String>Read-onlyNot-Before date.
clientcertnotafter<String>Read-onlyNot-After date.
daystoexpiration<Integer>Read-onlyDays remaining for the certificate to expire.
subject<String>Read-onlySubject name.
publickey<String>Read-onlyPublic key algorithm.
publickeysize<Integer>Read-onlySize of the public key.
version<Integer>Read-onlyVersion.
priority<Double>Read-onlyocsp priority.
status<String>Read-onlyStatus of the certificate.
Possible values = Valid, Not yet valid, Expired
passcrypt<String>Read-onlyPasscrypt.
Minimum length = 1
data<Double>Read-onlyVserver Id.
servicename<String>Read-onlyService name to which the certificate key pair is bound.
ocspresponsestatus<String>Read-onlyOcsp response status of the certificate.
Possible values = NONE, EXPIRED, VALID
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| DELETE| UPDATE| UNSET| LINK| UNLINK| CHANGE| GET (ALL)| 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 redand placeholder content is marked in <green>.

add

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"sslcertkey":{
<b>"certkey":<String_value>,
</b><b>"cert":<String_value>,
</b>"key":<String_value>,
"password":<Boolean_value>,
"fipskey":<String_value>,
"hsmkey":<String_value>,
"inform":<String_value>,
"passplain":<String_value>,
"expirymonitor":<String_value>,
"notificationperiod":<Double_value>,
"bundle":<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/sslcertkey/certkey_value<String>

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

update

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"sslcertkey":{
<b>"certkey":<String_value>,
</b>"expirymonitor":<String_value>,
"notificationperiod":<Double_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/sslcertkey?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"sslcertkey":{
<b>"certkey":<String_value>,
</b>"expirymonitor":true,
"notificationperiod":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

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?action=link

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"sslcertkey":{
<b>"certkey":<String_value>,
</b><b>"linkcertkeyname":<String_value>
</b>}}

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

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?action=unlink

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"sslcertkey":{
<b>"certkey":<String_value>
</b>}}

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

change

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?action=update

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"sslcertkey":{
<b>"certkey":<String_value>,
</b>"cert":<String_value>,
"key":<String_value>,
"password":<Boolean_value>,
"fipskey":<String_value>,
"inform":<String_value>,
"passplain":<String_value>,
"nodomaincheck":<Boolean_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

get (all)

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of sslcertkey resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?pagesize=#no;pageno=#no

Use this query-parameter to get the sslcertkey 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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "sslcertkey": [ {
"certkey":<String_value>,
"cert":<String_value>,
"key":<String_value>,
"inform":<String_value>,
"signaturealg":<String_value>,
"certificatetype":<String[]_value>,
"serial":<String_value>,
"issuer":<String_value>,
"clientcertnotbefore":<String_value>,
"clientcertnotafter":<String_value>,
"daystoexpiration":<Integer_value>,
"subject":<String_value>,
"publickey":<String_value>,
"publickeysize":<Integer_value>,
"version":<Integer_value>,
"priority":<Double_value>,
"status":<String_value>,
"fipskey":<String_value>,
"hsmkey":<String_value>,
"passcrypt":<String_value>,
"data":<Double_value>,
"servicename":<String_value>,
"expirymonitor":<String_value>,
"notificationperiod":<Double_value>,
"linkcertkeyname":<String_value>,
"ocspresponsestatus":<String_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http://<netscaler-ip-address>/nitro/v1/config/sslcertkey/certkey_value<String>?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "sslcertkey": [ {
"certkey":<String_value>,
"cert":<String_value>,
"key":<String_value>,
"inform":<String_value>,
"signaturealg":<String_value>,
"certificatetype":<String[]_value>,
"serial":<String_value>,
"issuer":<String_value>,
"clientcertnotbefore":<String_value>,
"clientcertnotafter":<String_value>,
"daystoexpiration":<Integer_value>,
"subject":<String_value>,
"publickey":<String_value>,
"publickeysize":<Integer_value>,
"version":<Integer_value>,
"priority":<Double_value>,
"status":<String_value>,
"fipskey":<String_value>,
"hsmkey":<String_value>,
"passcrypt":<String_value>,
"data":<Double_value>,
"servicename":<String_value>,
"expirymonitor":<String_value>,
"notificationperiod":<Double_value>,
"linkcertkeyname":<String_value>,
"ocspresponsestatus":<String_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/sslcertkey?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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "sslcertkey": [ { "__count": "#no"} ] }