ns_ssl_csr¶

Configuration for CSR File resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
commonname	<String>	Read-write	Common Name. Minimum length = 1
statename	<String>	Read-write	State Name. Minimum length = 2 Maximum length = 128
organizationname	<String>	Read-write	Organization Name. Minimum length = 1
keyform	<String>	Read-write	Key Form.
file_location_path	<String>	Read-write	File Location on Client for download. Minimum length = 1
city	<String>	Read-write	City.
file_name	<String>	Read-write	Name for and, optionally, path to the certificate signing request (CSR). Minimum length = 1 Maximum length = 256
countryname	<String>	Read-write	Country Name. Minimum length = 2 Maximum length = 128
keyfile	<String>	Read-write	Key File. Minimum length = 1 Maximum length = 128
passphrase	<String>	Read-write	Pass Phrase used to encrypt the private-key.
tenant_name	<String>	Read-only	Tenant Name.
file_size	<Integer>	Read-only	file_size.
file_last_modified	<String>	Read-only	Last Modified.
csr	<String>	Read-only	Generated CSR.
file_last_modified_epoch	<Double>	Read-only	Last Modified (Epoch).

Operations¶

(click to see Properties )

ADD
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

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>      "commonname":<String_value></b>,
<b>      "statename":<String_value></b>,
<b>      "organizationname":<String_value></b>,
<b>      "file_name":<String_value></b>,
<b>      "countryname":<String_value></b>,
<b>      "keyfile":<String_value></b>,
      "keyform":<String_value>,
      "city":<String_value>,
      "passphrase":<String_value>,
      "file_location_path":<String_value>}}

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":[{
      "tenant_name":<String_value>,
      "commonname":<String_value>,
      "statename":<String_value>,
      "file_size":<Integer_value>,
      "organizationname":<String_value>,
      "file_last_modified":<String_value>,
      "keyform":<String_value>,
      "is_dir":<Boolean_value>,
      "file_location_path":<String_value>,
      "city":<String_value>,
      "file_name":<String_value>,
      "countryname":<String_value>,
      "csr":<String_value>,
      "keyfile":<String_value>,
      "passphrase":<String_value>,
      "file_last_modified_epoch":<Double_value>}]}

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 }

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":[{
      "tenant_name":<String_value>,
      "commonname":<String_value>,
      "statename":<String_value>,
      "file_size":<Integer_value>,
      "organizationname":<String_value>,
      "file_last_modified":<String_value>,
      "keyform":<String_value>,
      "is_dir":<Boolean_value>,
      "file_location_path":<String_value>,
      "city":<String_value>,
      "file_name":<String_value>,
      "countryname":<String_value>,
      "csr":<String_value>,
      "keyfile":<String_value>,
      "passphrase":<String_value>,
      "file_last_modified_epoch":<Double_value>}]}

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":[{
      "tenant_name":<String_value>,
      "commonname":<String_value>,
      "statename":<String_value>,
      "file_size":<Integer_value>,
      "organizationname":<String_value>,
      "file_last_modified":<String_value>,
      "keyform":<String_value>,
      "is_dir":<Boolean_value>,
      "file_location_path":<String_value>,
      "city":<String_value>,
      "file_name":<String_value>,
      "countryname":<String_value>,
      "csr":<String_value>,
      "keyfile":<String_value>,
      "passphrase":<String_value>,
      "file_last_modified_epoch":<Double_value>}]}

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

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 }