Instaclustr Logo
Powered by Redocly

AWS Encryption Key V2

List all AWS encryption keys

SecurityBasic Authentication
Responses
200

Successfully retrieved registered AWS KMS encryption keys.

get/cluster-management/v2/data-sources/providers/aws/encryption-keys/v2
Request samples 
curl -i -X GET \
  -u <username>:<password> \
  https://api.instaclustr.com/cluster-management/v2/data-sources/providers/aws/encryption-keys/v2
Response samples
application/json
[
  • {
    }
]

Validate encryption Key

SecurityBasic Authentication
Request
path Parameters
encryptionKeyId
required
string <uuid>

ID of the encryption key.

Responses
200

Encryption Key validation response.

404

Encryption key not found

get/cluster-management/v2/operations/providers/aws/encryption-keys/v2/{encryptionKeyId}/validate/v2
Request samples 
curl -i -X GET \
  -u <username>:<password> \
  'https://api.instaclustr.com/cluster-management/v2/operations/providers/aws/encryption-keys/v2/{encryptionKeyId}/validate/v2'
Response samples
application/json
{
  • "regions": [
    ],
  • "isValid": true,
  • "message": "string"
}

Add an AWS KMS encryption key

SecurityBasic Authentication
Request
Request Body schema: application/json
required
alias
required
string [ 1 .. 30 ] characters ^[a-zA-Z0-9_-]{1}[a-zA-Z0-9 _-]*$

Encryption key alias for display purposes.

arn
required
string

AWS ARN for the encryption key.

providerAccountName
string

For customers running in their own account. Your provider account can be found on the Create Cluster page on the Instaclustr Console, or the "Provider Account" property on any existing cluster. For customers provisioning on Instaclustr's cloud provider accounts, this property may be omitted.

Responses
202

Successfully added the AWS encryption key.

post/cluster-management/v2/resources/providers/aws/encryption-keys/v2
Request samples
application/json
{
  • "alias": "encryption_key",
  • "arn": "arn:aws:kms:us-east-1:123456789123:key/123abcde-4567-8910-abcd-123456789abc"
}
Response samples
application/json
{
  • "alias": "encryption_key",
  • "arn": "arn:aws:kms:us-east-1:123456789123:key/123abcde-4567-8910-abcd-123456789abc"
}

Get encryption key details

SecurityBasic Authentication
Request
path Parameters
encryptionKeyId
required
string <uuid>

ID of the encryption key.

Responses
200

Retrieved the details of the encryption key.

404

Encryption key not found

get/cluster-management/v2/resources/providers/aws/encryption-keys/v2/{encryptionKeyId}
Request samples 
curl -i -X GET \
  -u <username>:<password> \
  'https://api.instaclustr.com/cluster-management/v2/resources/providers/aws/encryption-keys/v2/{encryptionKeyId}'
Response samples
application/json
{
  • "alias": "encryption_key",
  • "arn": "arn:aws:kms:us-east-1:123456789123:key/123abcde-4567-8910-abcd-123456789abc"
}

Delete encryption key

SecurityBasic Authentication
Request
path Parameters
encryptionKeyId
required
string <uuid>

ID of the encryption key.

Responses
204

Encryption key successfully deleted.

404

Encryption key not found

delete/cluster-management/v2/resources/providers/aws/encryption-keys/v2/{encryptionKeyId}
Request samples 
curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.instaclustr.com/cluster-management/v2/resources/providers/aws/encryption-keys/v2/{encryptionKeyId}'
Response samples
application/json
{
  • "errors": [
    ]
}
➔ Next to AWS Endpoint Service Principals V2