Delete Key Default Rollover REST Service

Use the Add Key Default Rollover REST Service to remove a wrapping key rollover that is specified in a rollover list.

Operation
DELETE
URL
https://host:port/SKLM/rest/v1/rollover/3592/{uuid}

By default, Guardium® Key Lifecycle Manager server listens to the secure port 9443 (HTTPS) for communication. During IBM® Security Guardium Key Lifecycle Manager installation, you can modify this default port.

Request

Request Parameters
Parameter Description
host Specify the IP address or hostname of the IBM Security Guardium Key Lifecycle Manager server.
port Specify the port number on which the IBM Security Guardium Key Lifecycle Manager server listens for requests.
Request Headers
Header name Value
Content-Type application/json
Accept application/json
Authorization SKLMAuth userAuthId=<authIdValue>
Accept-Language Any valid locale that is supported by IBM Security Guardium Key Lifecycle Manager. For example, en or de.
Request body

JSON object with the following specification:

JSON property name Description
uuid

Specify the universal unique identifier of an existing key rollover.

To get the uuid of the wrapping key, you can use the List Key Default Rollover REST Service.

Response

Response Headers
Header name Value and description
Status Code
200 OK
The request was successful. The response body contains the requested representation.
400 Bad Request
The authentication information was not provided in the correct format.
401 Unauthorized
The authentication credentials were missing or incorrect.
404 Not Found Error
The processing of the request fails.
500 Internal Server Error
The processing of the request fails because of an unexpected condition on the server.
Content-Type application/json
Content-Language Locale for the response message.
Success response body

JSON object with the following specification:

JSON property name Description
code Returns the code that is specified by the status property.
status Returns the status to indicate whether the key group is marked for rollover.
Error Response Body

JSON object with the following specification.

JSON property name Description
code Returns the application error code.
message Returns a message that describes the error.

Examples

Service request to delete a default key rollover with uuid specified
DELETE https://localhost:port/SKLM/rest/v1/rollover/3592/ROLLOVER-d70d6f8-90409301-ecc7-4e3e-ad25-e687b8f9d5ee
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Success response
Status Code: 200 OK
{
  "status": "Succeeded"
}
Service request to delete a default certificate rollover when an incorrect uuid is specified
DELETE https://localhost:port/SKLM/rest/v1/rollover/3592/KEY-d70d6f8-a6bd4208-5b4a-4907-88c0-bf61fb802de5
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Error response
{
  "code": "CTGKM3036E",
  "message": "CTGKM3036E Cannot find the specified rollover task."
}