This is an archive version of the document. To get the most up-to-date information, see the current version.Get Collection of Key Vaults
You can get information on all Key Vaults available for Veeam Backup for Microsoft Azure.
Request
To retrieve Key Vaults details, send the HTTP GET request to the /cloudInfrastructure/keyVaults endpoint.
HTTP Request
GET https://<hostname>/api/v3/cloudInfrastructure/keyVaults |
Query Parameters
To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:
Query Parameter | Value | Description |
|---|---|---|
RegionIds | string | Returns Key Vaults that reside in the specified Azure regions. |
Sync | boolean | Defines whether Veeam Backup for Microsoft Azure database is synchronized with the Azure resources. |
SubscriptionId | string | Returns only Key Vaults available to the specified subscription. For more information, see Filter Parameters. |
TenantId | string | Returns only Key Vaults available to the specified tenant. For more information, see Filter Parameters. |
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 |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for Microsoft Azure returns a representation of the /cloudInfrastructure/keyVaults collection. The KeyVaultV3 schema is used for the representation.
Example
The following request returns Key Vault.
|