Synchronizing OCI Keys
Use the post /v1/cckm/oci/synchronization-jobs API to synchronize OCI keys of all or particular vaults.
Syntax
curl -k '<IP>/api/v1/cckm/oci/synchronization-jobs' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n "vaults": ["<vault-1>, <vault-2>, <vault-3>"],\n "synchronize_all": false\n}' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
| vaults | array of strings | ID of the vault from which keys will be synchronized. Provide resource ID or vault ID of the OCI vault. |
| synchronize_all | boolean | Whether to synchronize all keys from all vaults. Set true to synchronize all keys from all vaults. synchronize_all and vaults are mutually exclusive - specify either. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/oci/synchronization-jobs' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxYzU1ZWY0Yi01MThjLTQ5ZmMtODRmMy1mYjk4MGY4YTQ3ODQiLCJzdWIiOiJsb2NhbHwyZjBmZWViNC02MjkwLTQ4ZWQtYmU1Yy0wYmU4NTVkMzE4NzMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODU3ZDEyYjItNjljZi00OWY1LThkYjktMjI0NWMwODNiODg5Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6Ijg1NTRhOWJhLTE1OTgtNDE0OC04YWMwLWYwZWJkNjJlMThmOSIsImlhdCI6MTY0Mzg2MzI1MywiZXhwIjoxNjQzODYzNTUzfQ.F6D3QgJLvFY0UyltBn6TfmiET-kExTl7RcvsmYzg550' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n "vaults": ["5e9ee2f1-1b90-4b7d-b319-2b0848e78e75"],\n "synchronize_all": false\n}' --compressed
Example Response
{
"id": "45f1c056-ad1f-41b7-bf68-2b2909e51ab9",
"uri": "kylo:kylo:cckm:synchronize:45f1c056-ad1f-41b7-bf68-2b2909e51ab9",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2022-02-03T04:19:34.327771067Z",
"updatedAt": "2022-02-03T04:19:34.329301488Z",
"overall_status": "in_progress",
"cloud": "oci",
"key_vaults": [
"5e9ee2f1-1b90-4b7d-b319-2b0848e78e75"
],
"abort": false
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.