Blocking Access to External Vaults
Use the post /v1/cckm/oci/vaults/{id}/block API to block access to the encrypt, decrypt, and get metadata requests to an external vault. This API is only applicable to the external vaults.
Syntax
curl -k 'https://127.0.0.1/api/v1/cckm/oci/vaults/69d754ac-9af7-4b08-9cf3-6514beda38bd/block' -X POST -H 'Authorization: Bearer AUTHTOKEN' -H 'accept: application/json' --compressed
Here, {id} is the resource ID of the external vault on the CipherTrust Data Security Platform Service.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authentication token. |
Example Request
curl -k 'https://127.0.0.1/api/v1/cckm/oci/vaults/69d754ac-9af7-4b08-9cf3-6514beda38bd/block' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNmYwYTFlMS1jMzIzLTQ1MDctODY3NC00NzlmZTMzNTJmNWEiLCJzdWIiOiJsb2NhbHxiMzVkNmEyZS05NmRiLTQzMzItOTRjNy00Y2Q5NjI1N2U3ZTgiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYzEyYWMzZWEtNWM0Yi00ZTM2LWJjMGYtNGY4MzExY2JkOGRjIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImM5NTU4ODkyLWNjNmUtNGM5ZC1iYmI4LThjZDA0ZGY1YzBiNCIsImlhdCI6MTY2NTU2NjQ4MywiZXhwIjoxNjY1NTY2NzgzfQ.OdiK-z3Fflqa1PxK4YFXothgkDrSYXjskdlPLFozYlU' -H 'accept: application/json' --compressed
Example Response
{
"id": "3cce1ed1-fe53-4e85-9d52-27d759dec63a",
"uri": "kylo:kylo:cckm:oci-vaults:3cce1ed1-fe53-4e85-9d52-27d759dec63a",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2022-09-23T20:44:49.561251Z",
"updatedAt": "2022-09-28T08:59:17.152218Z",
"compartment_id": "ocid1.tenancy.oc1..aaaaaaaadixb52q2mvlsn634ql5aaal6hb2vg7audpd4d4mcf5zluymff6sq",
"cloud_name": "oci",
"connection": "oci",
"vault_type": "EXTERNAL",
"tenancy": "gemaltoproductdev",
"region": "us-ashburn-1",
"compartment_name": "gemaltoproductdev",
"vault_name": "3cce1ed1-fe53-4e85-9d52-27d759dec63a",
"local_key_store_id": "3cce1ed1-fe53-4e85-9d52-27d759dec63a",
"endpoint_url": "https://www.3cce1ed1-fe53-4e85-9d52-27d759dec63a.com",
"endpoint_url_hostname": "3cce1ed1-fe53-4e85-9d52-27d759dec63a",
"linked_state": "true",
"external_vault_type": "local",
"client_application_id": "3cce1ed1-fe53-4e85-9d52-27d759dec63a",
"blocked": true
}
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
