Set Encryption Key (v2)

The Set Encryption Key (v2) REST API provides a Bring Your Own Key ( BYOK) solution to include Oracle EPM Cloud in your standard key management rotation.

The API can be used to set and remove a user-defined encryption key for access to database used in an Oracle EPM Cloud instance.

This is an asynchronous job and uses the job status URI to determine if the operation is complete.

This API is version v2.

Required Roles

Service Administrator

Table 10-17 Set Encryption Key

Task	Request	REST Resource
Execute a Job	PUT	`/interop/rest/v2/services/setencryptionkey`
Retrieve Job Status	GET	`/interop/rest/v2/status/jobs/777`

REST Resource

PUT interop/rest/v2/services/setencryptionkey

Supported Media Types: application/json

Note:

Before using the REST resources, you must understand how to access the REST resources and other important concepts. See Implementation Best Practices for EPM Cloud REST APIs. Using this REST API requires prerequisites. See Prerequisites.

The following table summarizes the request parameters.

Table 10-18 Parameters

Name	Description	Type	Required	Default
`parameters`
`key`	The user-defined encryption key. If empty or no key is passed, encryption is reset.	Payload	No	None

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/services/setencryptionkey

   {"parameters": {"key": "se!m+a2J"}}

Response

Supported Media Types: application/json

Table 10-19 Parameters

Parameters	Description
`details`	In case of errors, details are published with the error string
`status`	See Migration Status Codes
`links`	Detailed information about the link
`href`	Links to API call or status API
`action`	The HTTP call type
`rel`	Can be `self` and/or `Job Status`. If set to `Job Status`, you can use the `href` to get the status of the import operation
`data`	null

Example of Response Body

The following shows an example of the response body in JSON format.

{
	"status": -1,
	"items": null,
	"links": [{
		"rel": "self",
		"href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/services/setencryptionkey",
		"data": null,
		"action": "PUT"
	}, {
		"rel": "Job Status",
		"href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/status/jobs/8921378039543483",
		"data": null,
		"action": "GET"
	}],
	"details": null
}

Sample cURL command

curl -X PUT -s -u '<USERNAME>:<PASSWORD>' -o response.txt -D respHeader.txt -H 'Content-Type: application/json' -d '{"parameters":{"key":"abc"}}' 'https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/interop/rest/v2/services/setencryptionkey'