Enable SSE on the QDS Control Plane¶
-
PUT/api/v1.2/account¶
Use this API to enable SSE-KMS on the QDS Control Plane.
The QDS Control Plane denotes all the components except the clusters.
For more details, see Enabling SSE-KMS. Refer to Data Encryption Mapping within QDS (AWS) to see the mapping of SSE with different engines and the QDS Control Plane.
Parameters¶
Note
Parameters marked in bold below are mandatory. Others are optional and have default values.
| Parameter | Description |
|---|---|
| sse_algo | It is the algorithm used for encryption. Currently, Qubole supports AES256 and KMS on the QDS
Control Plane. Qubole only supports configuring SSE-KMS for this parameter (that is through this API).
To set SSE=AES256 on the QDS Control Plane, you must create a ticket with
Qubole Support. |
| sse_key | Use this parameter to specify the key for encrypting data. If you do not specify the key, then the default S3 KMS key is used. You must set this parameter to the specific KMS key in the Key ARN format if you do not want the default S3 KMS key. |
Request API Syntax¶
curl -X PUT -H "X-AUTH-TOKEN:<AUTH-TOKEN>" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{ "sse_algo":"SSE-KMS", "sse_key":"<sse-kms-key-ARN>" }' "https://api.qubole.com/api/v1.2/account/"
Note
The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.
Sample API Request¶
curl -X PUT -H "X-AUTH-TOKEN:<AUTH-TOKEN>" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{ "sse_algo":"SSE-KMS", "sse_key":"<sse-kms-key-ARN>" }' "https://api.qubole.com/api/v1.2/account/"
Remove SSE on the QDS Control Plane¶
Request API Syntax¶
curl -X PUT -H "X-AUTH-TOKEN:${X_AUTH_TOKEN}" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{ "sse_algo":null, "sse_key":null }' "https://api.qubole.com/api/v1.2/account/"
Note
The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.