Azure Key Vaults

The /cloudInfrastructure/keyVaults resource collection represents Azure Key Vaults available to Veeam Backup for Microsoft Azure.

Get Collection of Key Vaults

The HTTP GET request to the /cloudInfrastructure/keyVaults endpoint retrieves a list of Key Vaults available for Veeam Backup for Microsoft Azure.

SecurityBearer

Request

query Parameters

Offset	integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
RegionIds	Array of strings or null Returns Key Vaults that reside in Azure regions with the specified IDs. x-veeam-parameter-group: KeyVaultOptions
SearchPattern	string or null Returns items of a resource collection whose names match the specified search pattern in the parameter value. x-veeam-parameter-group: KeyVaultOptions
Sync	boolean or null Defines whether to force rescanning of the Microsoft Azure infrastructure before the response. x-veeam-parameter-group: KeyVaultOptions
SubscriptionId	string or null <uuid> Returns only Key Vaults that belong to an Azure subscription with the specified ID. x-veeam-parameter-group: KeyVaultOptions
TenantId	string or null <uuid> Returns only Key Vaults that belong to a tenant with the specified ID. x-veeam-parameter-group: KeyVaultOptions
ServiceAccountId	string Returns only Key Vaults to which a service account with the specified system ID has permissions. x-veeam-parameter-group: KeyVaultOptions

Responses

200

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/keyVaults

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/keyVaults?Offset=0&Limit=-1&RegionIds=string&SearchPattern=string&Sync=true&SubscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&TenantId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"id": "string",
"name": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}
]
}

Get Key Vault Data

The HTTP GET request to the /cloudInfrastructure/keyVaults/{keyVaultId} endpoint retrieves information on a Key Vault with the specified ID.

SecurityBearer

Request

path Parameters

keyVaultId

required

string or null

Specifies the system ID assigned to a Key Vault in the Veeam Backup for Microsoft Azure REST API.

query Parameters

sync	boolean or null Defines whether to force rescanning of the Microsoft Azure infrastructure before the response.

Responses

200

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/keyVaults/{keyVaultId}

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/keyVaults/{keyVaultId}?sync=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
}
}

Get Collection of Keys

The HTTP GET request to the /cloudInfrastructure/keyVaults/{keyVaultId}/keys endpoint retrieves a list of cryptographic keys stored in a Key Vault with the specified ID.

SecurityBearer

Request

path Parameters

keyVaultId

required

string

Specifies the system ID assigned to a Key Vault in the Veeam Backup for Microsoft Azure REST API.

query Parameters

Offset	integer <int32> >= 0 Specifies the first N items of a resource collection that will be excluded from the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit	integer <int32> >= -1 Specifies the maximum number of items of a resource collection that will be returned in the response. x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
SearchPattern	string or null Returns items of a resource collection whose names match the specified search pattern in the parameter value. x-veeam-parameter-group: KeyVaultKeyOptions
ServiceAccountId	string <uuid> Returns only keys to which a service account with the specified system ID has permissions. x-veeam-parameter-group: KeyVaultKeyOptions

Responses

200

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/keyVaults/{keyVaultId}/keys

Request samples

curl

curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/keyVaults/{keyVaultId}/keys?Offset=0&Limit=-1&SearchPattern=string&ServiceAccountId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"offset": 0,
"limit": 0,
"totalCount": 0,
"_links": {"property1": {"href": "http://example.com"
},
"property2": {"href": "http://example.com"
}
},
"results": [{"name": "string",
"version": "string",
"uri": "string",
"keyVaultUri": "string"
}
]
}