Developer Documentation
ADM NITRO APIs

ns_ssl_csr

June 20, 2023
Contributed by: 
C

Configuration for CSR File resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
statename Read-write State Name.

Minimum length = 2

Maximum length = 128
issuer Read-write Third party Certificate Authority provider.
keyform Read-write Key Form.
keyalgorithm Read-write Key Algorithm.Possible values: RSA, ECC.
app_name Read-write Application name.Used for tracking task logs created for a specific application.
certificate_dn Read-write Applicable only if the issuer is Venafi. Certificate path is populated in this field..
keystrength Read-write Key bits in size, if algorithm is RSA.EllipticCurve, if algorithm is ECC.
city Read-write City.
file_name Read-write Name for and, optionally, path to the certificate signing request (CSR).

Minimum length = 1

Maximum length = 256
countryname Read-write Country Name.

Minimum length = 2

Maximum length = 128
policy Read-write Applicable only if the issuer is Venafi.Policy folder path which determines the certificate attributes..
passphrase Read-write Pass Phrase used to encrypt the private-key.
is_deploy Read-write Whether Auto deployment of certificates managed by third party CA should be done by ADM..
commonname Read-write Common Name.

Minimum length = 1
organizationname Read-write Organization Name.

Minimum length = 1
organizationunit Read-write Organization Unit.
file_location_path Read-write File Location on Client for download.

Minimum length = 1
subjaltname Read-write Subject alternative name.
keyfile Read-write Key File.

Minimum length = 1

Maximum length = 128
certificate_name Read-write Name of the certificate.
serial_number Read-only Serial Number.
file_size Read-only file_size.
file_last_modified_epoch Read-only Last Modified (Epoch).
tenant_name Read-only Tenant Name.
activity_id Read-only Activity Id used to track the progress of create certificate.
file_last_modified Read-only Last Modified.
csr Read-only Generated CSR.

Operations

(click to see Properties )

  • CREATE_CERTIFICATE
  • ADD
  • RENEW_CERTIFICATE
  • UPLOAD
  • DELETE
  • GET (ALL)
  • GET
  • 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

create_certificate

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_csr?action=create_certificate;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_csr": {
"statename":<String_value>,
"keyform":<String_value>,
"issuer":<String_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"city":<String_value>,
"keystrength":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"commonname":<String_value>,
"is_deploy":<Boolean_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"certificate_name":<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_csr":[{
"serial_number":<String_value>,
"statename":<String_value>,
"file_size":<Integer_value>,
"issuer":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"certificate_dn":<String_value>,
"keystrength":<String_value>,
"city":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"file_last_modified_epoch":<Double_value>,
"is_deploy":<Boolean_value>,
"commonname":<String_value>,
"tenant_name":<String_value>,
"activity_id":<String_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_last_modified":<String_value>,
"certificate_policy_object":<certificate_policy_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"csr":<String_value>,
"certificate_name":<String_value>}]}

<!--NeedCopy-->

add

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_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_csr": {
<b>"statename":<String_value></b>,
<b>"file_name":<String_value></b>,
<b>"countryname":<String_value></b>,
<b>"commonname":<String_value></b>,
<b>"organizationname":<String_value></b>,
<b>"keyfile":<String_value></b>,
"keyform":<String_value>,
"issuer":<String_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"city":<String_value>,
"keystrength":<String_value>,
"certificate_dn":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"is_deploy":<Boolean_value>,
"organizationunit":<String_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"certificate_name":<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_csr":[{
"serial_number":<String_value>,
"statename":<String_value>,
"file_size":<Integer_value>,
"issuer":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"certificate_dn":<String_value>,
"keystrength":<String_value>,
"city":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"file_last_modified_epoch":<Double_value>,
"is_deploy":<Boolean_value>,
"commonname":<String_value>,
"tenant_name":<String_value>,
"activity_id":<String_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_last_modified":<String_value>,
"certificate_policy_object":<certificate_policy_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"csr":<String_value>,
"certificate_name":<String_value>}]}

<!--NeedCopy-->

renew_certificate

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_csr?action=renew_certificate;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_csr": {
"statename":<String_value>,
"keyform":<String_value>,
"issuer":<String_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"city":<String_value>,
"keystrength":<String_value>,
"certificate_dn":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"commonname":<String_value>,
"is_deploy":<Boolean_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"certificate_name":<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_csr":[{
"serial_number":<String_value>,
"statename":<String_value>,
"file_size":<Integer_value>,
"issuer":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"certificate_dn":<String_value>,
"keystrength":<String_value>,
"city":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"file_last_modified_epoch":<Double_value>,
"is_deploy":<Boolean_value>,
"commonname":<String_value>,
"tenant_name":<String_value>,
"activity_id":<String_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_last_modified":<String_value>,
"certificate_policy_object":<certificate_policy_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"csr":<String_value>,
"certificate_name":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_csr/file_name_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-->

get (all)

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

filter https://<MGMT-IP>/nitro/v2/config/ns_ssl_csr ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of ns_ssl_csr 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_csr ?pagesize=#no;pageno=#no Use this query-parameter to get the ns_ssl_csr resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/ns_ssl_csr ?count=yes Use this query-parameter to get the count of ns_ssl_csr 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_csr":[{
"serial_number":<String_value>,
"statename":<String_value>,
"file_size":<Integer_value>,
"issuer":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"certificate_dn":<String_value>,
"keystrength":<String_value>,
"city":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"file_last_modified_epoch":<Double_value>,
"is_deploy":<Boolean_value>,
"commonname":<String_value>,
"tenant_name":<String_value>,
"activity_id":<String_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_last_modified":<String_value>,
"certificate_policy_object":<certificate_policy_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"csr":<String_value>,
"certificate_name":<String_value>}]}

<!--NeedCopy-->

get

URL: https://<MGMT-IP>/nitro/v2/config/ns_ssl_csr/file_name_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_csr":[{
"serial_number":<String_value>,
"statename":<String_value>,
"file_size":<Integer_value>,
"issuer":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"keyalgorithm":<String_value>,
"app_name":<String_value>,
"certificate_dn":<String_value>,
"keystrength":<String_value>,
"city":<String_value>,
"file_name":<String_value>,
"countryname":<String_value>,
"policy":<String_value>,
"passphrase":<String_value>,
"file_last_modified_epoch":<Double_value>,
"is_deploy":<Boolean_value>,
"commonname":<String_value>,
"tenant_name":<String_value>,
"activity_id":<String_value>,
"organizationname":<String_value>,
"organizationunit":<String_value>,
"file_last_modified":<String_value>,
"certificate_policy_object":<certificate_policy_value>,
"file_location_path":<String_value>,
"subjaltname":<String_value>,
"keyfile":<String_value>,
"csr":<String_value>,
"certificate_name":<String_value>}]}

<!--NeedCopy-->

upload

URL: https://<MGMT-IP>/nitro/v2/upload/ns_ssl_csr 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: 

Multi-part form data with File Stream
<!--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 }

<!--NeedCopy-->
ns_ssl_csr
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.