Use Device Group
Delete REST Service to
delete an empty customized device group such as myLTO
.
You cannot delete a device group if it contains any devices, keys,
or certificates. You also cannot delete a device family that IBM Security Guardium Key Lifecycle Manager provides.
- Operation
DELETE
- URL
- https://<host>:<port>/SKLM/rest/v1/deviceGroups/{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. |
Path parameters
Parameter name |
Description |
name |
Specify a user-defined name of an existing device
group. You cannot delete a device family that a customized device
group references. |
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 deletion of the
specified device group. |
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 an empty device group
DELETE https://localhost:<port>/SKLM/rest/v1/deviceGroups/newDevGrp
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Success response
Status Code: 200 OK
{"code":"0","status":"Succeeded"}
- Service request to delete a device
group that is not empty
DELETE https://localhost:<port>/SKLM/rest/v1/deviceGroups/myLTO
Content-Type: application/json
Accept: application/json
Authorization: SKLMAuth userAuthId=139aeh34567m
- Error response
Status Code: 500 Internal Server Error
{"code":"CTGKM1130E","message":"CTGKM1130E Cannot delete a device
group when keys, certificates, groups, or devices are attached to
that device group."}