Get Collection of Key Vaults

In this article

    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

    • 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 the /cloudInfrastructure/keyVaults collection. The KeyVaultV3 schema is used for the representation.

    Get Collection of Key VaultsExample

    The following request returns Key Vault.

    Request:

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

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200

     

    Response Body:

    {

     "offset": 0,

     "limit": 200,

     "totalCount": 38,

     "results": [

       {

         "id": "zs6q48j3dxgufeuda89wy4hwu6yg6wrnt7zoko3b1by3in6yyk3y",

         "name": "AzKeyVault",

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

         "_links": {

           "self": {

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

           }

         }

       },

       {

         "id": "1a57j7w9a6hhgnz6995pxfin9czp6ukr5d3it9bhoy6hp3crwy4o",

         "name": "AzureKeyVault",

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

         "_links": {

           "self": {

             "href": "https://51.11.247.127/api/v3/cloudInfrastructure/keyVaults/1a57j7w9a6hhgnz6995pxfin9czp6ukr5d3it9bhoy6hp3crwy4o"

           }

         }

       }

     ],

     "_links": {

       "self": {

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

       }

     }

    }