Fetching List of OCI Vaults from Oracle
Use the post /v1/cckm/oci/get-vaults API to fetch the Oracle Cloud Infrastructure (OCI) vaults based on an Oracle connection on the CipherTrust Manager.
Syntax
curl -k '<IP>/api/v1/cckm/oci/get-vaults' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n "compartment_id": "<oci-compartment-id>",\n "connection": "<oci-connection-name>",\n "region": "<oci-region>",\n "limit": <number>,\n "ociNextPage": ""\n}' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
| compartment_id | string | ID of the OCI compartment to get vaults from. |
| region | string | OCI region to get vaults from. |
| connection | string | Name or ID of the OCI connection. |
| limit | integer | Number of records to return in a paginated "List" call, but might not return that exact number. |
| ociNextPage | string | Parameter to get the remaining records. The limit to view the remaining remains the same as the limit parameter set for the first time. For example, if there are 20 vaults and you set limit to 11, then to view the remaining 9 vaults, use ociNextPage. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/oci/get-vaults' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmMDYzMTBmYy02NGVhLTQ4OTgtYmI3Mi05YTIwYzBkOTUxYzIiLCJzdWIiOiJsb2NhbHxmYzg2MjhkMC1mNjczLTRhMWYtYjQ3Yi1hM2I0ODVhMWU3OTQiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYzk4YzkyZTUtMjM0OS00YzU5LWJlZWYtODc2OTQ4ZjIwNzM0Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImQ4YzkxOGU0LTFiNjAtNGY2MS05M2NjLTdjYWUwYjE1Y2ZiYyIsImlhdCI6MTYzMzMxOTE4NywiZXhwIjoxNjMzMzE5NDg3fQ.SPNqpZ92HKpNR55XBEEOMJeJN4DnpGMZY21-anM-NBE' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n "connection": "OCI Connection",\n "limit": 1,\n "ociNextPage": ""\n}' --compressed
Example Response
{
"data": [
{
"compartmentId": "ocid1.tenancy.oc1..aaaaaaaadixbawsedrftgyhujikoll6hb2vg7audpd4d4mcf5zluymff6sq",
"cryptoEndpoint": "https://bzq2awsedrftgyhujikoluk-crypto.kms.us-ashburn-1.oraclecloud.com",
"displayName": "CCKM-Testing",
"id": "ocid1.vault.oc1.iad.bzq26sunaaeuk.abuwclawsedrftgyhujikolikl7pmfn7q6wogbigjryu4udtkinnkmyacrq",
"lifecycleState": "ACTIVE",
"managementEndpoint": "https://bzqawsedrftgyhujikoluk-management.kms.us-ashburn-1.oraclecloud.com",
"timeCreated": "2021-12-07T11:50:37.691Z",
"vaultType": "DEFAULT",
"definedTags": {},
"freeformTags": {
"testVault": "cckm"
}
},
{
"compartmentId": "ocid1.tenancy.oc1..aaaaaaaadixbawsedrftgyhujikolaal6hb2vg7audpd4d4mcf5zluymff6sq",
"cryptoEndpoint": "https://bzqawsedrftgyhujikolyg-crypto.kms.us-ashburn-1.oraclecloud.com",
"displayName": "CCKM",
"id": "ocid1.vault.oc1.iad.bzqyzunhaagyg.abuwcljrlzpbjpuawsedrftgyhujikol7dximukyazav4hyzgbpdtd7qnea",
"lifecycleState": "ACTIVE",
"managementEndpoint": "https://bzawsedrftgyhujikolyg-management.kms.us-ashburn-1.oraclecloud.com",
"timeCreated": "2021-11-11T08:17:44.093Z",
"vaultType": "DEFAULT",
"definedTags": {},
"freeformTags": {}
}
],
"opc-next-page": null
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.