Viewing the Job Status
Use the get /v1/cckm/sap/keys/jobs/{id}
API to view the latest status of the key operation job.
Syntax
curl -k '<IP>/api/v1/cckm/sap/keys/jobs/{id}' -H 'Authorization: Bearer AUTHTOKEN' --compressed
curl -k 'https://52.86.120.81/api/v1/cckm/sap/keys/jobs/5db60499-9f4f-4143-b963-370459d3cef1' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhNjE4MDA0ZC01MTVlLTRmMjAtODAxYy0zNWVjZDQ0NTMyMWIiLCJzdWIiOiJsb2NhbHw1MzI0ZjI2MS05MDA0LTQ2ODItYmVjZC04ZWNjZGMwOTgwNmMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiMDQ5MzgzMjItNjMwNi00YjQyLWI2ZjEtOWJhMDdkZDc1MTE3Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjZhNGRhMzFiLWY4MDktNGNjZC1iOWYyLWQ0ZjcxYmM2NzZkOSIsImlhdCI6MTYzNzc0ODY5NywiZXhwIjoxNjM3NzQ4OTk3fQ.idTzT2ZP1ciwClyGRNQ2NceWqFR_bWt4XSEQnchTsME' --compressed
Here, {id}
is the resource ID of the job on the CipherTrust Manager.
Request Parameters
Parameter | Type | Description |
---|---|---|
AUTHTOKEN | string | Authentication token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/sap/keys/jobs/5db60499-9f4f-4143-b963-370459d3cef1' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZjRlNmJkNi0wMzgzLTQ4MGMtYWZmZS0wYTQxNDgzZmVlNmUiLCJzdWIiOiJsb2NhbHxlNjM3NTVjOS01YzRhLTQ0NzUtOWI0Zi0wN2JjNzQxYjQ1MGEiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODJlZTQ2MzAtNjQwMi00MTQ3LTliNDYtNWE5YzU1OGVjZWU4Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImI4MThiN2MzLTk5NzItNDU0YS1iMjI0LWQ2NGQwOWVlOGRmNSIsImlhdCI6MTYzNDU0MzE0OSwiZXhwIjoxNjM0NTQzNDQ5fQ.KEXK5uaMecdIQT8QWsIqVn6szCz5VBPetDh8i2ePiLU' --compressed
Example Response
{
"id": "5db60499-9f4f-4143-b963-370459d3cef1",
"uri": "kylo:kylo:cckm:sap_job:5db60499-9f4f-4143-b963-370459d3cef1",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2021-11-24T09:54:45.962863Z",
"updatedAt": "2021-11-24T09:55:18.422743Z",
"cckm_key_id": "b707ea86-37bb-4212-ad09-2635698dbe4a",
"group_id": "489ac34d-3e9c-4be3-8c1c-2c383bf31461",
"job_id": "b6b65380-4c0d-4b39-853a-e54676fe6706",
"key_id": "89ac400d-254f-4a19-a1fa-8952a2dca56f",
"operation": "delete",
"creator_id": "69f41156-5197-490d-aa5f-f1ffb0ab4e66",
"creator_name": "creator.name@xyz.com",
"state": "SUCCESS"
}
The latest state of the job with the ID 5db60499-9f4f-4143-b963-370459d3cef1
is SUCCESS
. It indicates that the operation is successful.
Response Codes
Response Code | Description |
---|---|
2xx | Success |
4xx | Client errors |
5xx | Server errors |
Refer to HTTP status codes for details.