Developer Documentation
ADM NITRO APIs

ns_ssl_certkey

June 20, 2023
Contributed by: 
C

Configuration for SSL certificate on Citrix ADC resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
no_domain_check Read-write Specify this option to override the check for matching domain names during certificate update operation.
ns_ip_address Read-write List of Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
certkeypair_name Read-write Cert Key Pair Name.

Minimum length = 1

Maximum length = 128
certificate_dn Read-write For certificates created by Venafi,this property indicates the certificate distinguished name..
ssl_key Read-write Key.

Minimum length = 1

Maximum length = 128
id Read-write Id is system generated key for all ssl cert-keys entries. For download operation “id” must be provided in the format ;ltadc_ip_address;gt_;ltcertkeypair_name;gt.tgz.
key_data Read-write Key Data.

Maximum length = 16384
managed_by Read-write Indicates if the certificate is managed by a third party certificate management provider..
ssl_certificate Read-write Certificate.

Minimum length = 1

Maximum length = 128
certificate_data Read-write Certificate Data.

Maximum length = 16384
file_location_path Read-write File Location on Client for download.

Minimum length = 1
cert_format Read-write Certificate Format.

Maximum length = 64
certchainbinding <String[]> Read-write Certificate Chain binding..
app_name Read-write Application name.Used for tracking task logs created for a specific application.
password Read-write The pass-phrase that was used to encrypt the private-key..

Maximum length = 128
source_certificate Read-write CertKeyPair Name of the certificate that needs to installed in another instance.
file_name Read-write File Name.

Minimum length = 1

Maximum length = 256
certkeypair_arr <String[]> Read-write List of certkeypair_name.Used in cert binding operation..
source_ipaddress Read-write Citrix ADC IP of the certificate that needs to installed in another instance.
save_config Read-write true, if save config is required.
ns_ip_address_arr <String[]> Read-write List of Citrix ADC IP Address.

Minimum length = 1

Maximum length = 64
entity_binding_arr <ns_sslcertkey_binding[]> Read-write .
entity_name Read-write entity name.
snicert Read-write Indicates server certificate for SNI. Used in cert binding operation..
serial_number Read-only Serial Number.
signature_algorithm Read-only Signature Algorithm.
valid_from Read-only Valid From.
status Read-only Tells whether the certificate is still valid or not.
hostname Read-only Host Name of the device.
issuer Read-only Issuer.
public_key_size Read-only Public Key Size.
device_name Read-only Name of the device.
valid_to Read-only Valid To.
subject Read-only Subject.
version Read-only Version.
public_key_algorithm Read-only Public Key Algorithm.
days_to_expiry Read-only Days before SSL certificate expires.
poll_time Read-only Last Polling Time.
display_name Read-only Display Name of the device.
no_of_bound_entities Read-only no_of_bound_entities.
partition_name Read-only Name of Admin Partition. Blank means Default Partition.
subjaltname Read-only Comma separated Subject Alternative Names.
domain Read-only Domain name for certificate issuer.
datacenter_id Read-only Datacenter Id .
activity_id Read-only Activity Id used to track the progress of certificate operations..
csr Read-only Certificate Signing Request.

Operations

(click to see Properties )

  • INVENTORY
  • LIST_ENTITY_CERT
  • BIND_CERT
  • ADD
  • GET (ALL)
  • GET
  • DELETE
  • MODIFY
  • GEN_CSR
  • DOWNLOAD

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

inventory

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey?action=inventory;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"ns_ssl_certkey": {
"certchainbinding":<String_value[]>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"app_name":<String_value>,
"certkeypair_name":<String_value>,
"source_certificate":<String_value>,
"password":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value[]>,
"ssl_key":<String_value>,
"source_ipaddress":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"save_config":<Boolean_value>,
"managed_by":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"entity_name":<String_value>,
"entity_binding_arr":[{
<b>"id":<String_value></b>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>}],
"certificate_data":<String_value>,
"ssl_certificate":<String_value>,
"snicert":<Boolean_value>,
"file_location_path":<String_value>,
"cert_format":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

list_entity_cert

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey?action=list_entity_cert;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"ns_ssl_certkey": {
"certchainbinding":<String_value[]>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"app_name":<String_value>,
"certkeypair_name":<String_value>,
"source_certificate":<String_value>,
"password":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value[]>,
"ssl_key":<String_value>,
"source_ipaddress":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"save_config":<Boolean_value>,
"managed_by":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"entity_name":<String_value>,
"entity_binding_arr":[{
<b>"id":<String_value></b>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>}],
"certificate_data":<String_value>,
"ssl_certificate":<String_value>,
"snicert":<Boolean_value>,
"file_location_path":<String_value>,
"cert_format":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

bind_cert

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey?action=bind_cert;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"ns_ssl_certkey": {
"certchainbinding":<String_value[]>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"app_name":<String_value>,
"certkeypair_name":<String_value>,
"source_certificate":<String_value>,
"password":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value[]>,
"ssl_key":<String_value>,
"source_ipaddress":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"save_config":<Boolean_value>,
"managed_by":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"entity_name":<String_value>,
"entity_binding_arr":[{
<b>"id":<String_value></b>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>}],
"certificate_data":<String_value>,
"ssl_certificate":<String_value>,
"snicert":<Boolean_value>,
"file_location_path":<String_value>,
"cert_format":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

add

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"ns_ssl_certkey": {
<b>"certkeypair_name":<String_value></b>,
<b>"ns_ip_address_arr":<String_value[]></b>,
"certchainbinding":<String_value[]>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"app_name":<String_value>,
"source_certificate":<String_value>,
"password":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value[]>,
"ssl_key":<String_value>,
"source_ipaddress":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"save_config":<Boolean_value>,
"managed_by":<String_value>,
"entity_name":<String_value>,
"entity_binding_arr":[{
<b>"id":<String_value></b>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>}],
"certificate_data":<String_value>,
"ssl_certificate":<String_value>,
"snicert":<Boolean_value>,
"file_location_path":<String_value>,
"cert_format":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_ssl_certkey resources configured on the system. You can set a filter on any property of the resource.

pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_ssl_certkey resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey ?count=yes Use this query-parameter to get the count of ns_ssl_certkey resources.

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String> HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String> HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->

modify

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String> HTTPS Method: PUT

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"ns_ssl_certkey":{
<b>"id":<String_value></b>,
"certchainbinding":<String_value[]>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"app_name":<String_value>,
"certkeypair_name":<String_value>,
"source_certificate":<String_value>,
"password":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value[]>,
"ssl_key":<String_value>,
"source_ipaddress":<String_value>,
"key_data":<String_value>,
"save_config":<Boolean_value>,
"managed_by":<String_value>,
"ns_ip_address_arr":<String_value[]>,
"entity_name":<String_value>,
"entity_binding_arr":[{
<b>"id":<String_value></b>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>}],
"certificate_data":<String_value>,
"ssl_certificate":<String_value>,
"snicert":<Boolean_value>,
"file_location_path":<String_value>,
"cert_format":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"hostname":<String_value>,
"issuer":<String_value>,
"no_domain_check":<Boolean_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"certificate_dn":<String_value>,
"public_key_size":<Integer_value>,
"device_name":<String_value>,
"ssl_key":<String_value>,
"id":<String_value>,
"key_data":<String_value>,
"valid_to":<String_value>,
"subject":<String_value>,
"version":<Integer_value>,
"managed_by":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"poll_time":<Integer_value>,
"key_name":<String_value>,
"display_name":<String_value>,
"no_of_bound_entities":<Integer_value>,
"ssl_certificate":<String_value>,
"certificate_data":<String_value>,
"file_location_path":<String_value>,
"partition_name":<String_value>,
"subjaltname":<String_value>,
"cert_format":<String_value>,
"certchainbinding":<String_value>,
"app_name":<String_value>,
"password":<String_value>,
"source_certificate":<String_value>,
"domain":<String_value>,
"file_name":<String_value>,
"certkeypair_arr":<String_value>,
"source_ipaddress":<String_value>,
"save_config":<Boolean_value>,
"datacenter_id":<String_value>,
"activity_id":<String_value>,
"ns_ip_address_arr":<String_value>,
"entity_binding_arr":[{
"hostname":<String_value>,
"poll_time":<Integer_value>,
"display_name":<String_value>,
"ns_ip_address":<String_value>,
"certkeypair_name":<String_value>,
"entity_name":<String_value>,
"partition_name":<String_value>,
"entity_type":<String_value>,
"id":<String_value>}],
"entity_name":<String_value>,
"snicert":<Boolean_value>,
"csr":<String_value>}]}

<!--NeedCopy-->

gen_csr

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_certkey/id_value<String>?action=gen_csr;onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"ns_ssl_certkey": { }}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt}

<!--NeedCopy-->

download

URL: https://<MGMT-IP>/nitro/v2/download/;ltns_ip_address;gt_;ltcertkeypair_name;gt.tgz HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: Binary Stream

ns_ssl_certkey
June 20, 2023
Contributed by: 
C
June 20, 2023
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.