Canceling a Domain Refresh
Use the post /v1/cckm/external-cm/refresh/{id}/cancel API to cancel a domain refresh process.
Syntax
curl -k '<IP>/api/v1/cckm/external-cm/refresh/{id}/cancel' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Here, {id} represents the ID of the refresh process. Refer to Refreshing external CipherTrust Manager Domains to find out the ID of the refresh process.
Request Parameter
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/external-cm/refresh/8155fe39-570a-4132-92ca-e40b7640c7dc/cancel' -X POST -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": true
}
}
The output shows the "overall_status" of the key refresh process with ID b0301a8a-521c-43d3-8e37-3074d41242e0 is "in_progress". The output also shows the ID of the related domain.
Depending on the number of domains and their keys, the canceling a refresh process might take significant amount of time. To view the updated status of the process, run the get /v1/cckm/external-cm/refresh API. Refer to Getting Refresh Status of external CipherTrust Manager Domains for details.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
