Use the Delete Default Key Group for Rollover REST Service to remove a
key group rollover that is specified in a rollover list.
- Operation
DELETE
- URL
- https://host:port/SKLM/rest/v1/keygroups/rollover/{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 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. |
Path parameters
JSON property name |
Description |
uuid |
Required. Specify the universal unique identifier of an existing key group
rollover. |
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 |
status |
Returns the status to indicate the removal of key group 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. |
Example
- Service request to delete a default key group rollover with uuid
specified
-
DELETE https://localhost:port/SKLM/rest/v1/keygroups/rollover/1234
-
- Success response
-
Status Code: 200 OK
{"status","Successful"}
- Service request to delete a default key group rollover when an incorrect
uuid is specified
-
DELETE https://localhost:port/SKLM/rest/v1/keygroups/rollover/101
- Error response
-
{
"code": "CTGKM3036E",
"message": "CTGKM3036E Cannot find the specified rollover task."
}