Download full document:

ns_ssl_key

Configuration for NS SSL key File resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
tenant_name<String>Read-writeTenant Name.
keysize<Integer>Read-writeKey Size in bits.
keyform<String>Read-writeKey Form.
des_type<String>Read-writeDES Encryption type possible values des|des3..
file_location_path<String>Read-writeFile Location on Client for upload/download.
Minimum length = 1
password<String>Read-writePassword.
algo<String>Read-writeEncryption Algorithm supported RSA and DSA..
file_name<String>Read-writeKey File Name.
Minimum length = 1
Maximum length = 256
exponent<String>Read-writeExponent.
file_size<Integer>Read-onlyfile_size.
file_last_modified<String>Read-onlyLast Modified.

Operations

(click to see Properties)

CREATE| DELETE| GET (ALL)| GET| UPLOAD| 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>.

create

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_key?action=create;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_ssl_key: {
"keysize":<Integer_value>,
"keyform":<String_value>,
"des_type":<String_value>,
"password":<String_value>,
"file_name":<String_value>,
"algo":<String_value>,
"tenant_name":<String_value>,
"file_location_path":<String_value>,
"exponent":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

delete

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_key/file_name_value<String>

HTTP Method: null

Response Payload:

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

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_key

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_key/file_name_value<String>

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "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>}]}

upload

URL: https://<MGMT-IP>/nitro/v1/upload/ns_ssl_key

HTTP Method: null

Response Payload:

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

download

URL: https://<MGMT-IP>/nitro/v1/download/ns_ssl_key/file_name_value<String>

HTTP Method: null