CLI Reference - Encryption Keys

akeyless create-key --name <Key name> \
--alg <Key type> \
--delete-protection <Protection from accidental deletion of this item, [true/false]> \
--description <Key description> \
--split-level <The number of fragments that the item will be split into (Deafult = 2> \
--delete-protection <Protection from accidental deletion of this item, [true/false]>

akeyless create-classic-key --name <Key Name> \
--alg <Key type> \
--gateway-url <API Gateway URL:8000> \
--key-file-path <Path to file with the classic key value provided by user> \
--key-data <Base64-encoded classic key value provided by user> \
--cert <Path to a file that contain the certificate in a PEM format> \
--cert-file-data <PEM Certificate in a Base64 format> \
--delete-protection <Protection from accidental deletion of this item, [true/false]>

akeyless export-classic-key --name <Key name> \
--gateway-url <API Gateway URL:8000> \

akeyless create-dfc-key --name <Key name> \
 --alg <Key type> \
 --description <DFC key description> \
 --split-level <The number of fragments that the item will be split into [Default = 2]> \
 --delete-protection <Protection from accidental deletion of this item, [true/false]>

akeyless rotate-key -n <Key name> \
--gateway-url <API Gateway URL:8000> \ 
--new-key-data <The new value of the key, base64 encoded>

akeyless refresh-key --name <Key name>

akeyless assoc-target-item --target-name <The target to associate> \
--name <The item to associate> \
--vault-name <Name of the vault used> \
--key-operations <A list of allowed operations for the key>
--project-id <Project id of the GCP KMS> \
--location-id <Location id of the GCP KMS> \
--keyring-name <Keyring name of the GCP KMS> \
--purpose <Purpose if the key in GCP KMS>

akeyless get-rsa-public --name <RSA_private_Key_name>

akeyless upload-pkcs12 --name <Key name> \
--in <PKCS#12 input file (private key and certificate only>  \
--passphrase <Passphrase to unlock the pkcs#12 bundle> \
--description <Key description> \ 
--customer-frg-id <Customer fragment ID that will be used to split the key) \
--cert <Path to a file that contain the certificate in a PEM format> \
--delete-protection <Protection from accidental deletion of this item, [true/false]>

akeyless upload-rsa --name <Name of key to be created> \
--alg <Key type> \
--rsa-key-file-path <RSA private key file path> \
--rsa-key-data <RSA private key data, base64 encoded> \
--cert <Path to a file that contain the certificate in a PEM format> \
--cert-file-data <PEM Certificate in a Base64 format>

akeyless update-rotation-settings --name <Key name> \
--auto-rotate=<True/False> \
--rotation-interval <The number of days to wait between every automatic key rotation (7-365)>

akeyless encrypt -k <Key name> \
--display-id <Display id of the key to use in the encryption process \
--item-id <Item id of the key to use in the encryption process> \
--in <Path to the file to be encrypted in base64 format> \

akeyless encrypt-file --key-name <Key Name> \
--in <Path/to/file> \ 
--display-id <Display id of the key to use in the encryption process> \
--item-id <The item id of the key to use in the encryption process>

akeyless encrypt-pkcs1 -k <key Name> \
--plaintext <Data to encrypt> \
--display-id <Display id of the key to use in the encryption process> \
--item-id <Item id of the key to use in the encryption process>

akeyless encrypt-gpg -k <Key name> \
--display-id <Display id of the key to use in the encryption process \
--item-id <Item id of the key to use in the encryption process> \
--in <Path to the file to be encrypted in base64 format> \

akeyless decrypt --key-name <Key Name> \
--ciphertext <Ciphertext to be decrypt in base64 encoded format> \
--display-id <Display id of the key to use in the encryption process> \
--item-id <Item id of the key to use in the encryption process>

akeyless decrypt-file --key-name <key name> \
--in <file to decrypt> \
--display-id <Display id of the key to use in the decryption process> \ 
--item-id <Item id of the key to use in the encryption process>

akeyless decrypt-pkcs1 --key-name <RSA Key Name> \
--ciphertext <Ciphertxt to decrypt> \
--display-id <Display id of the key to use in the decryption process> \ 
--item-id <Item id of the key to use in the encryption process>

akeyless decrypt-gpg --key-name <Key Name> \
--ciphertext <Ciphertext to be decrypt in base64 encoded format> \
--display-id <Display id of the key to use in the encryption process> \
--item-id <Item id of the key to use in the encryption process>

akeyless sign-pkcs1 --key-name <RSA signing key name> \
--message <Message to sign> \
--display-id <Display id of the key to use in the decryption process> \
--item-id <Item id of the key to use in the encryption process>

akeyless verify-pkcs1 --key-name <RSA Key> \
--message <message to verify> \
--signature <message signature> \ 
--display-id <Display id of the key to use in the decryption process> \ 
--item-id <Item id of the key to use in the encryption process>

akeyless sign-gpg --key-name <RSA signing key name> \
--message <Message to sign> \
--display-id <Display id of the key to use in the decryption process> \
--item-id <Item id of the key to use in the encryption process>

akeyless verify-gpg --key-name <RSA Key> \
--message <message to verify> \
--signature <message signature> \ 
--display-id <Display id of the key to use in the decryption process> \ 
--item-id <Item id of the key to use in the encryption process>

akeyless hmac -p <plaintext> -f <hash function>

akeyless gen-customer-fragment --description <Customer Fragment Description>

akeyless gateway-download-customer-fragments -f <path to download to> -u <gateway URL>

akeyless set-item-state --name <Item name> \
--desired-state <Desired state>

akeyless create-tokenizer \
--name <Tokenizer name> \
--tokenizer-type <vaultless> \
--template-type <SSN, CreditCard, USPhoneNumber> \
--tweak-type <Supplied, Generated, Internal, Masking>

akeyless create-tokenizer \
--name <Tokenizer name> \
--tokenizer-type <vaultless> \
--template-type <Custom> \
--tweak-type <Supplied, Generated, Internal, Masking> \
--alphabet <Symbols to use for tokenization> \
--pattern <A regexp pattern to extract tokenized parts> \
--encoding-template <An expression to alter the template of the encryption output> \
--decoding-template <An expression to alter the template of the decryption output>

akeyless tokenize \
--tokenizer-name <Tokenizer name> \
--plaintext <Data to be encrypted> \
--tweak <Base64-encoded tweak value

akeyless detokenize \
--tokenizer-name <Tokenizer name> \
--ciphertext <Data to be decrypted> \
--tweak <Base64-encoded tweak value that was used for encryption>