API docs by Redocly

Konnect CMEK and Blob APIs (0.0.1)

Download OpenAPI specification:Download

CMEK

Customer Managed Encryption Keys

List CMEKs

List customer managed encryption keys

Authorizations:
personalAccessTokensystemAccountAccessToken
query Parameters
page[size]
integer
Example: page[size]=10

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

page[after]
string
Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

page[before]
string
Example: page[before]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

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

object

Filter CMEKs returned in the response.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

Get a CMEK

Get a customer managed encryption key

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
cmekId
required
string
Example: default

Id of the CMEK

Responses

Response samples

Content type
application/json
{
  • "id": "default",
  • "name": "My KMS Key",
  • "description": "My Key Description",
  • "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Replace a CMEK

Replace a customer managed encryption key

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
cmekId
required
string
Example: default

Id of the CMEK

Request Body schema: application/json

Request body schema for putting a CMEK.

key_arn
required
string

The ARN of the KMS key to use for encryption

name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "My KMS Key",
  • "description": "My Key Description",
  • "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
}

Response samples

Content type
application/json
{
  • "id": "default",
  • "name": "My KMS Key",
  • "description": "My Key Description",
  • "key_arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
  • "created_at": "2023-03-20T09:29:14.52Z",
  • "updated_at": "2023-03-21T09:29:14.52Z"
}

Delete a CMEK

Delete a customer managed encryption key

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
cmekId
required
string
Example: default

Id of the CMEK

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Blobs

Encrypted data blobs

Get a raw blob

Get a raw decrypted blob

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
blobId
required
string
Example: 680ed2c45c18562ab4448d54c6f962ff:reqres

Id of the Blob

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Store a raw blob

Store a raw blob of data

Authorizations:
personalAccessTokensystemAccountAccessToken
path Parameters
blobId
required
string
Example: 680ed2c45c18562ab4448d54c6f962ff:reqres

Id of the Blob

header Parameters
X-Konnect-Expires-In
integer
Default: 259200

Retention time (TTL) of the blob in seconds

X-Konnect-CMEK-Id
string
Default: default

The CMEK ID to use for encryption

Request Body schema: *

Raw blob data

string

Responses

Response samples

Content type
application/problem+json
{
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "instance": "string",
  • "detail": "string",
  • "invalid_parameters": [
    ]
}