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

Get Key Vault Data

You can get data on a Key Vault with the specified ID.

Request

To retrieve information on a Key Vault, send the HTTP GET request to the /cloudInfrastructure/keyVaults/{keyVaultId} endpoint. {keyVaultId} is a system ID assigned to the Key Vault.

HTTP Request

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

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 representation of a Key Vault with the specified ID. The KeyVaultV3 schema is used for the resource representation.

Get Key Vault DataExample

The following request returns information on a Key Vault with the ID zs6q48j3dxgufeuda89wy4hwu6yg6wrnt7zoko3b1by3in6yyk3y.

Request:

GET https://51.11.247.127/api/v3/cloudInfrastructure/keyVaults/zs6q48j3dxgufeuda89wy4hwu6yg6wrnt7zoko3b1by3in6yyk3y

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "zs6q48j3dxgufeuda89wy4hwu6yg6wrnt7zoko3b1by3in6yyk3y",

 "name": "abor-frcentral",

 "subscriptionId": "280921a2-220d-45c9-92dd-82b6d5a3a78f",

 "_links": {

   "self": {

     "href": "https://51.145.102.95/api/v3/cloudInfrastructure/keyVaults/zs6q48j3dxgufeuda89wy4hwu6yg6wrnt7zoko3b1by3in6yyk3y"

   }

 }

}