Viewing Synchronization Status
Use the get /v1/cckm/azure/certificates/synchronization-jobs API to view the list of updated synchronization status. The results can be filtered using the query parameters.
Syntax
curl -k '<IP>/api/v1/cckm/azure/certificates/synchronization-jobs?skip=0&limit=10' -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | Internal id of the synchronization. |
| overall_status | string | Overall status of the synchronization. Possible values are in_progress, completed, and failed. |
| key_vaults | array of strings | ID of the vault where the certificate is created. |
| skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
| limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/azure/certificates/synchronization-jobs?skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxYzU1ZWY0Yi01MThjLTQ5ZmMtODRmMy1mYjk4MGY4YTQ3ODQiLCJzdWIiOiJsb2NhbHwyZjBmZWViNC02MjkwLTQ4ZWQtYmU1Yy0wYmU4NTVkMzE4NzMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODU3ZDEyYjItNjljZi00OWY1LThkYjktMjI0NWMwODNiODg5Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6Ijg1NTRhOWJhLTE1OTgtNDE0OC04YWMwLWYwZWJkNjJlMThmOSIsImlhdCI6MTY0Mzg2MzI1MywiZXhwIjoxNjQzODYzNTUzfQ.F6D3QgJLvFY0UyltBn6TfmiET-kExTl7RcvsmYzg550' -H 'accept: application/json' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 2,
"resources": [
{
"id": "c90bfb5f-6ed0-4e94-b5b1-541577d83f30",
"uri": "kylo:kylo-36b619e0-7aed-4de7-958a-6d670b85ee71:cckm:synchronize:c90bfb5f-6ed0-4e94-b5b1-541577d83f30",
"account": "kylo:kylo-36b619e0-7aed-4de7-958a-6d670b85ee71:admin:accounts:kylo-36b619e0-7aed-4de7-958a-6d670b85ee71",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2022-05-17T09:40:35.546384Z",
"updatedAt": "2022-05-17T09:41:01.959323Z",
"completed_at": "2022-05-17T09:41:01.958222Z",
"overall_status": "completed",
"detailed_status": {
"northcentralus/cckm-demo-vault::260ecbe7-777b-4d3c-84ea-887620498863": "vault synchronized successfully",
"northcentralus/cckm-vault::260ecbe7-777b-4d3c-84ea-887620498863": "vault synchronized successfully"
},
"cloud": "AzureCloud",
"key_vaults": [
"cckm-vault::260ecbe7-777b-4d3c-84ea-887620498863",
"cckm-demo-vault::260ecbe7-777b-4d3c-84ea-887620498863"
],
"abort": false,
"sync_item": "azure-certificate"
},
{
"id": "51550607-e6fe-44f8-998a-c1455f0ecf50",
"uri": "kylo:kylo-36b619e0-7aed-4de7-958a-6d670b85ee71:cckm:synchronize:51550607-e6fe-44f8-998a-c1455f0ecf50",
"account": "kylo:kylo-36b619e0-7aed-4de7-958a-6d670b85ee71:admin:accounts:kylo-36b619e0-7aed-4de7-958a-6d670b85ee71",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2022-05-17T09:28:11.503991Z",
"updatedAt": "2022-05-17T09:28:26.999821Z",
"completed_at": "2022-05-17T09:28:26.999593Z",
"overall_status": "completed",
"detailed_status": {
"northcentralus/cckm-demo-vault::260ecbe7-777b-4d3c-84ea-887620498863": "vault synchronized successfully",
"northcentralus/cckm-vault::260ecbe7-777b-4d3c-84ea-887620498863": "vault synchronized successfully"
},
"cloud": "AzureCloud",
"key_vaults": [
"cckm-vault::260ecbe7-777b-4d3c-84ea-887620498863",
"cckm-demo-vault::260ecbe7-777b-4d3c-84ea-887620498863"
],
"abort": false,
"sync_item": "azure-certificate"
}
]
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
