ADC NITRO APIs

sslcertreq

August 17, 2023

Contributed by:

Configuration for certificate request resource.

Properties

(click to see Operations )

Name	Permissions	Description
reqfile	Read-write	Name for and, optionally, path to the certificate signing request (CSR). /nsconfig/ssl/ is the default path. Maximum length = 63
keyfile	Read-write	Name of and, optionally, path to the private key used to create the certificate signing request, which then becomes part of the certificate-key pair. The private key can be either an RSA or a DSA key. The key must be present in the appliance’s local storage. /nsconfig/ssl is the default path. Maximum length = 63
subjectaltname	Read-write	Subject Alternative Name (SAN) is an extension to X.509 that allows various values to be associated with a security certificate using a subjectAltName field. These values are called “Subject Alternative Names” (SAN). Names include Email addresses IP addresses URIs DNS names (this is usually also provided as the Common Name RDN within the Subject field of the main certificate.) Directory names (alternative Distinguished Names to that given in the Subject). Minimum length = 1
fipskeyname	Read-write	Name of the FIPS key used to create the certificate signing request. FIPS keys are created inside the Hardware Security Module of the FIPS card. Minimum length = 1 Maximum length = 31
keyform	Read-write	Format in which the key is stored on the appliance. Default value: PEM Possible values = DER, PEM
pempassphrase	Read-write	. Minimum length = 1 Maximum length = 31
countryname	Read-write	Two letter ISO code for your country. For example, US for United States. Minimum length = 2 Maximum length = 2
statename	Read-write	Full name of the state or province where your organization is located. Do not abbreviate. Minimum length = 1
organizationname	Read-write	Name of the organization that will use this certificate. The organization name (corporation, limited partnership, university, or government agency) must be registered with some authority at the national, state, or city level. Use the legal name under which the organization is registered. Do not abbreviate the organization name and do not use the following characters in the name Angle brackets (< >) tilde (~), exclamation mark, at (@), pound (#), zero (0), caret (^), asterisk (*), forward slash (/), square brackets ([ ]), question mark (?). Minimum length = 1
organizationunitname	Read-write	Name of the division or section in the organization that will use the certificate. Minimum length = 1
localityname	Read-write	Name of the city or town in which your organization’s head office is located. Minimum length = 1
commonname	Read-write	Fully qualified domain name for the company or web site. The common name must match the name used by DNS servers to do a DNS lookup of your server. Most browsers use this information for authenticating the server’s certificate during the SSL handshake. If the server name in the URL does not match the common name as given in the server certificate, the browser terminates the SSL handshake or prompts the user with a warning message. Do not use wildcard characters, such as asterisk (*) or question mark (?), and do not use an IP address as the common name. The common name must not contain the protocol specifier http:// or https://. Minimum length = 1
emailaddress	Read-write	Contact person’s e-mail address. This address is publically displayed as part of the certificate. Provide an e-mail address that is monitored by an administrator who can be contacted about the certificate. Minimum length = 1
challengepassword	Read-write	Pass phrase, embedded in the certificate signing request that is shared only between the client or server requesting the certificate and the SSL certificate issuer (typically the certificate authority). This pass phrase can be used to authenticate a client or server that is requesting a certificate from the certificate authority. Minimum length = 4
companyname	Read-write	Additional name for the company or web site. Minimum length = 1
digestmethod	Read-write	Digest algorithm used in creating CSR. Possible values = SHA1, SHA256

Operations

(click to see Properties )

CREATE

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

create

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"sslcertreq":{
<b>      "reqfile":<String_value>,
</b>      "keyfile":<String_value>,
      "subjectaltname":<String_value>,
      "fipskeyname":<String_value>,
      "keyform":<String_value>,
      "pempassphrase":<String_value>,
<b>      "countryname":<String_value>,
</b><b>      "statename":<String_value>,
</b><b>      "organizationname":<String_value>,
</b>      "organizationunitname":<String_value>,
      "localityname":<String_value>,
      "commonname":<String_value>,
      "emailaddress":<String_value>,
      "challengepassword":<String_value>,
      "companyname":<String_value>,
      "digestmethod":<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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

sslcertreq

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

sslcertreq

Properties

Operations

create

In this article