List CMEKs
List customer managed encryption keys.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Request the next page of data, starting with the item before this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Filter CMEKs returned in the response.
Show Child Parameters
Response
200 application/json
Response
List of CMEKs
CMEKList
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
Get a CMEK
Get a customer managed encryption key.
Path Parameters
Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints.
Allowed values:default
Default:default
Example:default
Response
application/json
Response
A CMEK
CMEK
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
Example:arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012
The name of the CMEK. We recommend you match the key’s name used in KMS.
>= 1 characters
Example:My KMS Key
An optional description of the CMEK.
Example:My Key Description
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Create or replace a CMEK
Create or replace a customer managed encryption key.
Path Parameters
Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints.
Allowed values:default
Default:default
Example:default
Body
application/json
Body
CMEK to be replaced
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
Example:arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012
The name of the CMEK. We recommend you match the key’s name used in KMS.
>= 1 characters
Example:My KMS Key
An optional description of the CMEK.
Example:My Key Description
Response
application/json
Response
A CMEK
CMEK
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.
Example:arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012
The name of the CMEK. We recommend you match the key’s name used in KMS.
>= 1 characters
Example:My KMS Key
An optional description of the CMEK.
Example:My Key Description
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete a CMEK
Delete a customer managed encryption key. Avoid revoking or deleting a KMS key and CMEK that is actively used by Konnect, as this can lead to data loss or service disruptions.
Path Parameters
Customer Managed Encryption Key identifier. This ID is selected from a predefined, Konnect-specific list of allowed values and uniquely identifies a CMEK configuration within a given organization and Konnect region. While not global in function, these IDs behave like scoped namespaces with enforced uniqueness and enumeration constraints.
Allowed values:default
Default:default
Example:default
Response
Response
Success
Authentication
Path Parameters
KMSARN
stringThe Amazon Resource Name (ARN) of the Key Management Service (KMS) key to use for encryption and decryption. We recommend using one multi-region key (MRK) per Konnect region to enhance security and compliance, while also supporting failover to other AWS regions.