Instaclustr Logo
Powered by Redocly

Encryption Key

Operations related to encryption keys.

List all encryption keys

List encryption keys previously added to the account

SecurityBasic Authentication
Responses
200

Successfully retrieved all encryption keys

400

Bad Request

401

Not Authorized

403

Forbidden

404

No encryption keys are associated with this account.

415

Unsupported media type: returned when the payload is in an unsupported format.

429

Too many requests: returned when more than 35 requests per second are being received by your user.

get/provisioning/v1/encryption-keys
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add encryption key
Add an encryption key to the account, please see here for more information on sharing a KMS key with Instaclustr.


SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
Encryption key to be added


alias
required
string  [ 1 .. 30 ] characters ^[a-zA-Z0-9_-]{1}[a-zA-Z0-9 _-]*$
Encryption key alias


 
arn
required
string  non-empty 
AWS ARN for the encryption key


 
provider
string
 
providerAccount
string  non-empty 
Name of the provider account. Defaults to INSTACLUSTR. Must be explicitly provided for Run-In-Your-Own-Account customers.


 
Responses 
202
The encryption key has been successfully added.


400
Invalid encryption key


401
Not Authorized


403
Forbidden


404
Resource not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


post/provisioning/v1/encryption-keys
Request samples 
application/json
{
  • "alias": "virginia 1",
  • "arn": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789abc",
  • "provider": "string",
  • "providerAccount": "INSTACLUSTR"
}
Response samples 
application/json
{
  • "id": "ff4fccf3-2ac0-494b-9f40-e95288dd752d",
  • "alias": "string",
  • "arn": {
    },
  • "accountPrimaryKey": "6d8a718d-52d3-4a6d-8eb8-e97431f55bbf",
  • "inUse": true,
  • "providerAccount": "string"
}
Delete encryption key
Delete an encryption key from the account


SecurityBasic Authentication 
Request 
path Parameters
keyId
required
string <uuid> 
The ID of the encryption key to be deleted


 
 Example:  ff4fccf3-2ac0-494b-9f40-e95288dd752d
Responses 
202
Successfully deleted an encryption key


400
Encryption key in use. Data centres using this key need to be deleted first.


401
Not Authorized


403
Forbidden


404
Key does not exist.


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


delete/provisioning/v1/encryption-keys/{keyId}
Request samples 
Response samples 
application/json
{
  • "message": "delete encryption key request accepted"
}
Validate encryption Key
SecurityBasic Authentication 
Request 
path Parameters
keyId
required
string <uuid> 
The ID of the encryption key to be validated


 
 Example:  ff4fccf3-2ac0-494b-9f40-e95288dd752d
Responses 
200
Encryption Key validation response


400
Encryption key is not a valid UUID


401
Not Authorized


403
Forbidden


404
Encryption key not found


415
Unsupported media type: returned when the payload is in an unsupported format.


429
Too many requests: returned when more than 35 requests per second are being received by your user.


get/provisioning/v1/encryption-keys/{keyId}/valid
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Firewall Rule