Device Delete REST Service

Use Device Delete REST Service to remove information that identifies a device from the IBM® Security Guardium® Key Lifecycle Manager database. If the device in the DS5000 device family and the machine affinity is enabled, deletion of the device removes relationship between a device and a machine.

Operation
DELETE
URL
https://<host>:<port>/SKLM/rest/v1/devices/{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.
path parameter

JSON object with the following specification:

Property name Description
uuid Required. Specify the universal unique identifier of the device, such as DEVICE-74386920-148c-47b2-a1e2-d19194b315cf.

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 deletion of a device was successful.
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 device
DELETE https://localhost:<port>/SKLM/rest/v1/devices/DEVICE-74386920-148c-
47b2-a1e2-d19194b315cf
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Success response
Status Code: 200 OK
{"code":"0","status":"Succeeded"}
Error response when there is no device
DELETE https://localhost:<port>/SKLM/rest/v1/devices/DEVICE-74386920-148c
-47b2-a1e2-d19194b315cf
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Error response
Status Code: 500 Internal Server Error
{"code":"CTGKM0569E","message":"CTGKM0569E Cannot find the device: 
DEVICE-74386920-148c-47b2-a1e2-d19194b315cf"}