Fetching the Metadata of External Vaults
Use the get /v1/cckm/oci/ekm/v1/vaults/{vaultId}/metadata API to get external vault metadata and check whether the external vault is reachable and can perform cryptographic operations. The API returns the state of the external vault (ACTIVE or BLOCKED) and the vendor name.
The supported scope value is oci_hyok_getVaultMetadata.
When running the API, {vaultId} is the resource ID of the external vault on the CipherTrust Manager.
Header
| Parameter | Type | Description |
|---|---|---|
| opc-request-id | String | Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. |
Example Request
get https://<Host IP Address>/api//v1/cckm/oci/ekm/v1/vaults/{vaultId}/metadata
<authorization token and other headers>
Example Response
{
"state": "ACTIVE",
"vendor": "Thales CTM"
}
The output shows that the external vault with the specified ID is ACTIVE, and its vendor is Thales CTM. The output indicates that the vault is reachable and can be used for performing cryptographic operations.
Response Codes
| Response Code | Description |
|---|---|
| 200 | Ok |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Not found |
| 403 | Forbidden |
| 500 | Internal server error |
Refer to HTTP status codes for details.
