Getting Refresh Status of External CipherTrust Manager Domains

Use the get /v1/cckm/external-cm/refresh API to view the updated status of a domain refresh process. For this, you need the ID of the key refresh process.

Syntax

curl -k '<IP>/api/v1/cckm/external-cm/refresh?skip=0&limit=10' -H 'Authorization: Bearer AUTHTOKEN' --compressed

Request Parameter

Parameter	Type	Description
AUTHTOKEN	string	Authorization token.

Request Query Parameters

Parameter	Type	Description
id	string	ID of the refresh process. Refer to Refreshing external CipherTrust Manager Domains to find out the ID of the refresh process.
overall_status	string	Overall status of the refresh process.
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/external-cm/refresh?skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdiYzNkOWM4LWRiYTQtNDVmMy05YWNiLWI3NGM2MzQyYzYyMCIsImlhdCI6MTYxNDc1MTg1MSwiZXhwIjoxNjE0NzUyMTUxfQ.ahdxfM7-WA4u7sotHy6qelc9MkoZytst7oZWsvE7Cr0' --compressed

Example Response

{
    "application/json": {
        "id": "bf27cde1-e2ed-4244-9d5a-8a4e12ad1837",
        "uri": "kylo:kylo:cckm:synchronize:bf27cde1-e2ed-4244-9d5a-8a4e12ad1837",
        "account": "kylo:kylo:admin:accounts:kylo",
        "application": "ncryptify:gemalto:admin:apps:kylo",
        "devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
        "createdAt": "2020-08-06T09:49:34.605578452Z",
        "updatedAt": "2020-08-06T09:49:34.609059131Z",
        "overall_status": "in progress",
        "cloud": "externalCM",
        "domains": [
            "3e732d57-5ea1-491f-b238-9f4a39a9566f",
            "c4e5bd34-af39-4027-9058-6f1a4bb3519d"
        ],
        "abort": false
    }
}

The output shows the "overall_status" of the key refresh process is "completed". The "detailed_status" shows the status of individual domains. In the sample output, the "detailed_status" of the domain with ID "6070915c-0ab4-4e7e-bf4d-31dd31214874" is "domain synchronized successfully".

Response Codes

Response Code	Description
2xx	Success
4xx	Client errors
5xx	Server errors

Refer to HTTP status codes for details.

Suggest A Change