Set the SSL key material for an existing SSL key configuration (POST)
The POST command sets or updates the SSL key material with content from a specified private key file. The key configuration must already exist in the system.
Request parameters
Parameter | Description | Example |
---|---|---|
key-name 1 | Name of SSL key configuration for which the user wants to set or update the key material. |
|
usr 1 | User name of a user with the security role. Only security users can update the SSL key configuration. | usr=security |
pwd 1 | Password of the security user. | pwd=ytiruces |
key-file-name 1 | Name of the private key file. The file can contain a PEM pass phrase or certificate and private key information in the PFX format. | key-file-name=newKey.pfx |
key-password | Password of the key, if the key requires it. | key-password=ytiruces |
1 This parameter is required.
Request syntax
Or, if you have a password protected private key:
Sample successful response
<status result="success" />
</response>
Sample unsuccessful 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-commands
SSL-Key-Management-API-error-messages
Configuration-API-error-code-reference