Operations at EncryptionKeyManagement

This page describes the backend methods at this endpoint.

Signature	Description
EncryptionKeyInfo ChangeKeyStatusToReplication(String keyId)	Changes key status to 'Replication Key'. Returns updated key info.
EncryptionKeyInfo ChangeKeyStatusToUniversal(ChangeKeyStatusToUniversalRequest request)	Changes key status to 'Universal Key'. Returns updated key info.
Void ChangePassphrase(ChangePassphraseRequest request)	Changes the passphrase for the specified key.
EncryptionKeyInfo Create(NewEncryptionKeyRequest request)	Creates a new key with the specified name and passphrase.
Void DeleteKey(String keyId)	Deletes an encryption key or throws exception if selected key is used.
ExportedKey Export(String keyId)	Exports a key.
EncryptionKeyInfoCollection GetFilteredKeys(EncryptionKeyStatus encryptionKeyStatus)	Gets the filtered list of encryption keys. Pass the type of the keys as parameter
EncryptionKeyInfoCollection GetKeys()	Gets the list of encryption keys.
EncryptionKeyInfo GetUsedKey(String agentId)	Returns encryption key used by agent.
EncryptionKeyInfo Import(ExportedKey key)	Imports an exported key. Returns imported key info.
EncryptionKeyInfo LockKey(String keyId)	Locks the specified key. Returns updated key info.
SerializedExportedKey SerializedExport(String keyId)	Returns serialized binary representation of encryption key by given key ID.
EncryptionKeyInfo SerializedImport(SerializedExportedKey key)	Imports an encryption key by given serialized binary representation. Returns imported key info.
EncryptionKeyInfo UnlockKey(UnlockKeyRequest request)	Unlocks the specified key. Returns updated key info.
EncryptionKeyInfo UpdateDescription(String keyId, EncryptionKeyInfo key)	Updates existing key name and comment. Returns updated key info.