Canceling a Domain Refresh
Use the post /v1/cckm/external-cm/refresh/{id}/cancel
API to cancel a domain refresh process.
Syntax
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
Example Response
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.