This is the multi-page printable view of this section. Click here to print.
Encrypt Data
1 - 1.1
scpcli kms kms encrypt
--key_id <value>
--plaintext <value>
Description
Encrypts the provided plaintext(base64 encoded) using key(Purpose: encryption/decryption)
State ACTIVE (CURRENT)
| Version | Supported Until |
|---|---|
| 1.1 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| plaintext required | string | Data(base64 encoded) to encrypt | dGhlIHF1aWNrIGJyb3duIGZveAo= |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | Encrypted data by KMS | vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | Version of KMS key | 1 |
2 - 1.0
scpcli kms kms encrypt
--key_id <value>
--plaintext <value>
Description
Encrypts the provided plaintext(base64 encoded) using key(Purpose: encryption/decryption)
State ACTIVE (DEPRECATED)
| Version | Supported Until |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| key_id required | string | Resource id of KMS key | 138c2fc8c29a449dbfa8681f8f1d78e2 |
| plaintext required | string | Data(base64 encoded) to encrypt | dGhlIHF1aWNrIGJyb3duIGZveAo= |
Responses
| Name | Description | Example |
|---|---|---|
| ciphertext | Encrypted data by KMS | vault:v283:YiUpW1bpF2fMY0VRh3aQpik781Ul2gFPsfdwsypwouccHtPSfRaE40wTHHl4a5AK |
| key_version | Version of KMS key | 1 |