List Files REST Service

Use the List Files REST Service to retrieve the list of files under the specified directory.

Operation
GET
URL
https://host:port/GKLM/rest/v1/directory/files









By default, IBM® Guardium Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM 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 Guardium Key Lifecycle Manager server. 






port

Specify the port number on which the IBM 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 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








type

Specify the type of the directory. The default type is folder. Valid values
are rootDrives and folder.






path



The directory path where the files are stored. The default path is
SKLM_DATA.




















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 files under the specified directory





GET https://localhost:port/GKLM/rest/v1/directory/defaultBackupDirectory







Success response





Status: 200 OK
{
  "tklm.backup.dir": "${SKLM_DATA}"
}