Use the Device Types Name Delete REST Service to delete an empty
user-defined device group, such as myLTO.
- Operation
DELETE- URL
- https://host:port/SKLM/rest/v1/deviceTypes/{name}
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. |
Query parameters
| Parameter name |
Description |
| name |
Specify the name of the user-defined device group that you want to delete. You
cannot delete a device family that is referenced by the user-defined device group. |
Request
Success response body
JSON array that contains JSON objects with the following specification:
| JSON property name |
Description |
| deviceFamily |
|
| device.enableMachineAffinity |
Indicates that the device group is enabled to store the association of a
device to an existing machine identifier in the IBM Security Guardium Key Lifecycle Manager database. To modify this value, you must
have a role with permissions to create or modify and also have permission to the DS5000 device
group. Valid values are true or
false.
|
| enableKMIPDelete |
Indicates whether deletion is enabled on the object or not. Valid values are
true or false. |
| longName |
Returns the long name of the device group. |
| shortName |
Returns the short name of the device group. |
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 |
|
| status |
|
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 user-defined device group
-
DELETE https://localhost:port/SKLM/rest/v1/deviceTypes/myPEER_TO_PEER
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
Accept-Language : en
- Success response
-
{
"code": "0",
"status": "Succeeded"
}