Use the Backup is Running REST Service to determine whether the backup
task is running.
- Operation
GET
- URL
- https://host:port/SKLM/rest/v1/ckms/backups/isrunning
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. |
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 |
code |
Returns 0 if the backup task is running. Returns
1 if the backup task is not running. |
status |
Returns the status message to indicate whether the backup task is running or
not. |
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 determine whether the backup task is running
GET https://localhost:port/SKLM/rest/v1/ckms/backups/isrunning
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=4259b494-9cb2-4414-87b4-9a17b9f916c7
Accept-Language : en
-
- Success response when the backup process is not running
-
{
"code":"1",
"status":"CTGKM3291I Backup process is not running."
}
- Success response when the backup process is running
-
{
"code":"0",
"status":"CTGKM3290I Backup process is running."
}
- Invalid service request (when the user is not authenticated)
-
GET https://localhost:port/SKLM/rest/v1/ckms/backups/isrunning
Content-Type: application/json
Accept : application/json
Accept-Language : en
- Error response
-
Status Code : 400 Bad Request
Content-Language: en
{"code":"CTGKM6002E","message":"CTGKM6002E Bad Request: Invalid user
authentication ID or invalid request format."}