Use Device Group Export File Delete REST Service to delete an export
file from the IBM® Security Guardium® Key Lifecycle Manager database.
- Operation
DELETE- URL
- https://host:port//SKLM/rest/v1/ckms/deviceGroupsExport/deleteExportFile?exportFilePath=<path_of_the_export_file>
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 object with the following specification
| Property name |
Description |
| exportFilePath |
Specify the export file name and path for deletion. |
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 Code |
Returns the success code 204 No Content. |
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 an export file
DELETE https://localhost:port/SKLM/rest/v1/ckms/deviceGroupsExport/deleteExportFile?
exportFilePath=C:\\BackupDir\\sklm_v3.0.0.0_20170728040703-1200_export.exp
- Success response
Status Code : 204 No Content
- Error response
Status Code : 404 Not Found
{"code":0,"status":"CTGKM2925E Error deleting file : "."}