Refreshing External CipherTrust Manager Domains

Use the post /v1/cckm/external-cm/refresh API to refresh keys in external CipherTrust Manager domains. Keys of individual, multiple, or all domains can be refreshed.

To refresh multiple domains, specify their IDs separated by commas, and set synchronize_all to false.
To refresh all domains, set synchronize_all to true.

Note

domains and synchronize_all are mutually exclusive - specify either.

Syntax

curl -k '<IP>/api/v1/cckm/external-cm/refresh' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' --data-binary $'{\n  \n  "synchronize_all": <true|false>\n}' --compressed

Request Parameters

Parameter	Type	Description
AUTHTOKEN	string	Authorization token.
domains	array of strings	IDs of external CipherTrust Manager domains from which you want to refresh keys.
synchronize_all	boolean	Whether to refresh all keys in all domains. Set to `true` to refresh all domains, else set to `false`.

Example Request

curl -k 'https://127.0.0.1/api/v1/cckm/external-cm/refresh' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MmFmZDExNy02YzllLTRhNGUtOTAwYS1lYjlhNDNjYWE5ZDIiLCJzdWIiOiJsb2NhbHwzMTI5ODdkMS0wOWNiLTQxZTEtOThmNy1jZjRhNzgwNTZiMTMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiNDVmOWE3NWUtMzI1NC00NWJkLWE0NzYtOWU2NWUyNjdmNGVkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjdiYzNkOWM4LWRiYTQtNDVmMy05YWNiLWI3NGM2MzQyYzYyMCIsImlhdCI6MTYxNDc1MTg1MSwiZXhwIjoxNjE0NzUyMTUxfQ.ahdxfM7-WA4u7sotHy6qelc9MkoZytst7oZWsvE7Cr0' -H 'Content-Type: application/json' --data-binary $'{\n  \n  "synchronize_all": true\n}' --compressed

Example Response

{
    "application/json": {
        "id": "45bc07e5-8956-4830-be84-2011d4cd0e82",
        "uri": "kylo:kylo:cckm:synchronize:45bc07e5-8956-4830-be84-2011d4cd0e82",
        "account": "kylo:kylo:admin:accounts:kylo",
        "application": "ncryptify:gemalto:admin:apps:kylo",
        "devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
        "createdAt": "2023-01-23T10:41:50.899942091Z",
        "updatedAt": "2023-01-23T10:41:50.904396Z",
        "overall_status": "in_progress",
        "cloud": "externalCM",
        "domains": [
            "b3795eaa-76af-4185-8368-1f57c4c0c3ae",
            "a6208bc5-246e-455a-98f7-5c68774a8ecd"
        ],
        "abort": false
    }
}

The output shows the "overall_status" of the key refresh process with ID 8155fe39-570a-4132-92ca-e40b7640c7dc is "in_progress". The output also shows the ID of the domain being refreshed.

Depending on the number of domains and their keys, the refresh 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.

Suggest A Change