Get Default Backup Directory REST Service

Use the Get Default Backup Directory REST Service to display the default backup directory.

Operation
GET
URL
https://host:port/SKLM/rest/v1/directory/defaultBackupDirectory

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/octet-stream
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

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/octet-stream
Content-Language Locale for the response message.
Success response body

JSON array that contains JSON objects with the following specification:

JSON property name Description
tklm.backup.dir Returns the path to the backup directory that contains the backup files.
Error Response Body

JSON object with the following specification.

JSON property name Description
code Returns the application error code.
messageId Returns the status message identifier.
status Returns a message that describes the error.

Example

Service request to list the default backup directory
GET https://localhost:port/SKLM/rest/v1/directory/defaultBackupDirectory
Success response
Status: 200 OK
{
  "tklm.backup.dir": "${SKLM_DATA}"
}