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

Get Collection of Keys in Specific Key Vault

You can get a list of all secret keys located in the specified ID.

Request

To retrieve a list of all keys, send the HTTP GET request to the /cloudInfrastructure/keyVaults/{keyVaultId}/key endpoint. {keyVaultId} is a system ID assigned to the Key Vault.

HTTP Request

GET https://<hostname>/api/v3/cloudInfrastructure/keyVaults/{keyVaultId}/key

Query Parameters

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

Request Headers

The request contains the following headers.

Header

Required

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.

Response

The server returns the following response to the client.

Response Codes

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 Microsoft Azure returns a list of keys located in the Key Vault with the specified ID. The KeyVaultV3 schema is used for the resource representation.

Get Collection of Keys in Specific Key VaultExample

The following request returns a list of keys located in the Key Vault with the ID 43188btzbihuk3xysm1wu8tbrxz5ybgwpdtcrsd3px55ptn5bc5y.

Request:

GET https://51.11.247.127/api/v3/cloudInfrastructure/keyVaults/43188btzbihuk3xysm1wu8tbrxz5ybgwpdtcrsd3px55ptn5bc5y/keys

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 1,

 "results": [

   {

     "name": "AzureKeyVault",

     "version": "d45c87b584d44a66a74f9564ae750c00",

     "uri": "https://dept003.vault.azure.net/keys/jf-mk4-key/d45c87b584d44a66a74f9564ae750c00",

     "keyVaultUri": "https://key.vault.azure.net/"

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v3/cloudInfrastructure/keyVaults/43188btzbihuk3xysm1wu8tbrxz5ybgwpdtcrsd3px55ptn5bc5y/keys?offset=0&limit=200"

   }

 }

}