This is an archive version of the document. To get the most up-to-date information, see the current version.

Get Amazon Connection Encryption Keys

You can get a list of all encryption keys used in an amazon connection with the specified ID.

Request

To retrieve a representation of a collection of encryption keys, send the HTTP GET request to the /amazonConnections/{amazonConnectionId}/cloudEncryptionKeys endpoint. {amazonConnectionId} is a system ID assigned to the amazon connection in the Veeam Backup for AWS REST API.

HTTP Request

GET https://<hostname>:<port>/api/v1/amazonConnections/{amazonConnectionId}/cloudEncryptionKeys

Query Parameters

To control the amount and order of data in the response, you can use Offset and Limit query parameters.

Request Headers

The request contains the following headers.

Header

Required/Optional

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

x-api-version

Required

1.0-rev0

Specifies the current revision of the Veeam Backup for AWS REST API.

Accept

Optional

  • application/json
  • application/problem+json

Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type.

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-Length

integer

Identifies the length of the response body message, in bytes.

Content-Type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for AWS returns a list of encryption keys used in the amazon connection with the specified ID. The CloudEncryptionKey schema is used for the collection representation.

Get Amazon Connection Encryption KeysExample

The following request returns a full list of encryption keys of an amazon connection with the ID 2c7eb8fb-40e3-4495-9dc9-30f969277917.

Request:

GET https://135.169.170.192:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudEncryptionKeys

 

Request Header:

Authorization: Bearer <Access-Token>

x-api-version: 1.0-rev0

 

Response:

200

 

Response Body:

{

 "totalCount": 6,

 "results": [

   {

     "arn": "arn:aws:kms:eu-north-1:534095521853:key/55d664fc-2315-4dee-9acd-9f460022802a",

     "name": "aws/backup"

   },

   {

     "arn": "arn:aws:kms:eu-north-1:534095521853:key/f5863fd8-c01a-4daa-bf53-07e2e40fa006",

     "name": "aws/ebs"

   },

   {

     "arn": "arn:aws:kms:eu-north-1:534095521853:key/7e034548-645f-4f90-9c62-41062801cde4",

     "name": "aws/rds"

   },

   {

     "arn": "arn:aws:kms:eu-north-1:534095521853:key/70b923fa-afb8-403e-b669-872f9701af34",

     "name": "Pony"

   },

   {

     "arn": "arn:aws:kms:eu-north-1:534095521853:key/2c1a417a-a8e7-484d-a0b2-028b55ff187d",

     "name": "PonyA"

   },

   {

     "arn": "arn:aws:kms:eu-north-1:534095521853:key/e1cab087-c516-4eb2-b6f9-e39892769af2",

     "name": "PonyKeyRDS"

   }

 ],

 "_links": [

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudEncryptionKeys"

   },

   {

     "method": "GET",

     "rel": "self",

     "href": "https://135.169.170.192:11005/api/v1/amazonConnections/2c7eb8fb-40e3-4495-9dc9-30f969277917/cloudEncryptionKeys"

   }

 ]

}