List CMEKs

List customer managed encryption keys.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter CMEKs returned in the response.

Show Child Parameters

Response

200 application/json

List of CMEKs

CMEKList

dataarray[object]required
Show Child Parameters
metaobjectrequired

Pagination metadata.

Show Child Parameters
get/cmeks
 
200 application/json

Get a CMEK

Get a customer managed encryption key.

get

Path Parameters

cmekIdstringrequired

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

A CMEK

CMEK

idstringrequired
key_arnstringrequired

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

namestringrequired

The name of the CMEK. We recommend you match the key’s name used in KMS.

>= 1 characters

Example:My KMS Key

descriptionstring

An optional description of the CMEK.

Example:My Key Description

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

get/cmeks/{cmekId}
 
application/json

Create or replace a CMEK

Create or replace a customer managed encryption key.

put

Path Parameters

cmekIdstringrequired

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

CMEK to be replaced

key_arnstringrequired

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

namestringrequired

The name of the CMEK. We recommend you match the key’s name used in KMS.

>= 1 characters

Example:My KMS Key

descriptionstring

An optional description of the CMEK.

Example:My Key Description

Response

application/json

A CMEK

CMEK

idstringrequired
key_arnstringrequired

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

namestringrequired

The name of the CMEK. We recommend you match the key’s name used in KMS.

>= 1 characters

Example:My KMS Key

descriptionstring

An optional description of the CMEK.

Example:My Key Description

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/cmeks/{cmekId}

Body

{ "name": "My KMS Key", "description": "My Key Description", "key_arn": "arn:aws:kms:us-east-1:123456789012:key/mrk-12345678123412341234123456789012" }
 
application/json

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.

delete

Path Parameters

cmekIdstringrequired

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

Success

delete/cmeks/{cmekId}
 

KMSARN

string

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