ADC NITRO APIs

systemkek

Configuration for Key encryption Key resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
level <String> Read-write Type of update KEK to be performed.

*basic : The level basic will backup old keys and create new keys and respond back.

*extended : The level extended will backup old keys and create new keys, update

ns.conf, nscfg.db, all ns.conf for same release, in all partitions. While doing so

will block all config changes and once done shall respond back.

Possible values = basic, extended

Operations

(click to see Properties )

  • CHANGE

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

change

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemkek? action=update HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemkek":{
<b>"level":<String_value>
</b>}}

<!--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

systemkek