Add a new SSL key configuration (POST)


This POST command adds a new SSL key configuration to the system. If the key configuration already exists in the system, the system rejects it and returns an error. This command does not handle the key material. 

Request parameters

Parameter name

Description

Example

usr*

User name that initiates the request. The specified user must have security-level access.

usr=security

pwd*

Password of the security user that initiates the request.

pwd=ytiruces

* Required parameter.

Request syntax

POST https://<ipAddress>/rest/configurationapi/sslkeysapi/1.0/key/config?usr=<userName>&pwd=<password>

 

Post content

SSL key configuration XML definition

Syntax of XML definition
<keyConfig name="01_pfx_des_pas" server-ip="172.10.1.*" server-port="443">
  <description><![CDATA[Key managed by John]]></description>
</keyConfig> 

Attributes for XML definition

Attribute name

Description

Example

name*

Name given to the SSL key configuration.

name="01_pfx_des_pas"

server-ip*

IP address or range of IP addresses of the server(s) for which the key applies. Possible input options include:

  • 10.160.1.1
  • 172.10.*.*
  • 10.160.1.1-10.160.1.127

server-ip="172.10.1.*"

 

server-port*

Port or range of ports of the server for which the key applies. Possible input options include:

  • 8443

  • *

  • 8443-8446

server-port="443"

description

Description of the key.

[Key managed by John]

* Required attribute

Sample responses

Sample response for successful operation
 <response>
   <status result="success" />
</response>
Sample response for unsuccessful operation
<response>
 <status result="failure">
    <msg code="xxxx" severity="error">
       <![CDATA[Error message]]>
    </msg>
 </status>
</response>

Related topics

Composing-requests-in-configuration-APIs

SSL-Key-Management-API-error-messages

SSL-Key-Management-API-commands

Configuration-API-error-code-reference

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*