Use Delete Replication Config Property REST Service to
delete one or more properties from the ReplicationSKLMConfig.properties configuration
file to control the replication operation.
- Operation
DELETE
- URL
- https://<host>:<port>/SKLM/rest/v1/replicationConfigProperties
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. |
Request body
JSON property name |
Description |
propertyName |
Specify the replication configuration property
names that you want to delete. You can specify multiple comma-separated
properties. |
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 |
property |
Returns the property name that is deleted from
the replication configuration file. |
status |
Returns
the delete status to indicate whether
the configuration property was deleted. The status includes an appropriate
message. |
Note: The success response
code 200 OK
is
returned even if the property you requested is not found. An appropriate
message is returned in the response body.
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 configuration property
-
DELETE https://localhost:<port>/SKLM/rest/v1/replicationConfigProperties
{"propertyName" : "backup.ClientIP5"}
-
- Success response
-
Status Code : 200 OK
[{"propertyName":"backup.ClientIP5","status":"CTGKM0606I Update
successful, change will take effect immediately"}]
- Error response
-
Status Code : 400 Bad Request
Content-Language: en
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid
user authentication ID or invalid request format."}
- Service request
to delete multiple configuration properties
DELETE https://localhost:<port>/SKLM/rest/v1/replicationConfigProperties
{"property" : "replication.auditLogName,backup.ClientPort1"}
- Success response
Status Code : 200 OK
[{"propertyName":"replication.Incremental.Enable","status":"CTGKM0606I Update
successful, change will take effect immediately"},
"property":"backup.ClientPort1","status":"CTGKM0556E Cannot find the
property in configuration file: backup.ClientPort1 "}]
- Error response
Status Code : 400 Bad Request
{"code" : "CTGKM6002E", "message" : "CTGKM6002E Bad Request: Invalid
user authentication ID or invalid request format."}