ADM NITRO APIs

ns_ssl_key

June 20, 2023

Contributed by:

Configuration for Citrix ADC SSL key File resource.

Properties

(click to see Operations )

Name	Permissions	Description
keysize	Read-write	Key Size in bits.
keyform	Read-write	Key Form.
des_type	Read-write	DES Encryption type possible values des\|des3..
file_location_path	Read-write	File Location on Client for upload/download. Minimum length = 1
password	Read-write	Password.
algo	Read-write	Encryption Algorithm supported RSA and DSA..
file_name	Read-write	Key File Name. Minimum length = 1 Maximum length = 256
exponent	Read-write	Exponent.
ec_curve	Read-write	Elliptic curve.
tenant_name	Read-only	Tenant Name.
file_size	Read-only	file_size.
file_last_modified	Read-only	Last Modified.
file_last_modified_epoch	Read-only	Last Modified (Epoch).

Operations

(click to see Properties )

CREATE
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

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

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

{"ns_ssl_key": {
"keyform":<String_value>,
"password":<String_value>,
"file_name":<String_value>,
"algo":<String_value>,
"ec_curve":<String_value>,
"keysize":<Integer_value>,
"des_type":<String_value>,
"file_location_path":<String_value>,
"exponent":<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_key":[{
"tenant_name":<String_value>,
"keysize":<Integer_value>,
"file_size":<Integer_value>,
"file_last_modified":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"des_type":<String_value>,
"file_location_path":<String_value>,
"password":<String_value>,
"algo":<String_value>,
"file_name":<String_value>,
"exponent":<String_value>,
"ec_curve":<String_value>,
"file_last_modified_epoch":<Double_value>}]}

<!--NeedCopy-->

delete

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

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

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Payload:

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

<!--NeedCopy-->

get (all)

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

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

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

HTTPS Method: GET

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_key":[{
"tenant_name":<String_value>,
"keysize":<Integer_value>,
"file_size":<Integer_value>,
"file_last_modified":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"des_type":<String_value>,
"file_location_path":<String_value>,
"password":<String_value>,
"algo":<String_value>,
"file_name":<String_value>,
"exponent":<String_value>,
"ec_curve":<String_value>,
"file_last_modified_epoch":<Double_value>}]}

<!--NeedCopy-->

get

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

Request Headers: Accept: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "ns_ssl_key":[{
"tenant_name":<String_value>,
"keysize":<Integer_value>,
"file_size":<Integer_value>,
"file_last_modified":<String_value>,
"keyform":<String_value>,
"is_dir":<Boolean_value>,
"des_type":<String_value>,
"file_location_path":<String_value>,
"password":<String_value>,
"algo":<String_value>,
"file_name":<String_value>,
"exponent":<String_value>,
"ec_curve":<String_value>,
"file_last_modified_epoch":<Double_value>}]}

<!--NeedCopy-->

upload

URL: https://<MGMT-IP>/nitro/v2/upload/ns_ssl_key HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload:

Multi-part form data with File Stream
<!--NeedCopy-->

Response Payload:

{ "errorcode": 0, "message": "Done }

<!--NeedCopy-->

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

ns_ssl_key

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

ns_ssl_key

Properties

Operations

create

delete

get (all)

get

upload

In this article