Delete an SSL key configuration (DELETE)


The DELETE command deletes the key configuration for the specified name and mapping (server IP/range of IPs and port/range port ports). If no other mapping exists for the key, the command also deletes the key material.

Request parameters

Parameter

Description

Example

key-name 1

Name of SSL key configuration to delete. Do not provide the key material file name.

key-name=privateKey

server-ip 1

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 1

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

  • 8443

  • *

  • 8443-8446

server-port="443"

usr 1

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

usr=security

pwd 1

Password of the security user that initiates the request.

pwd=ytiruces

1 This parameter is required.

Sample request

https://<ipAddress>/rest/configurationapi/sslkeysapi/1.0/key/config/<key-name>/<server-ip>/<server-port>?user=<userName>&pwd=<password>

Sample successful response

<response>
  <status result="success" />
</response>

Sample unsuccessful response

<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

 

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