Validate Repository Settings
You can check whether settings you plan to specify for a repository are valid.
Request
To validate repository settings, send the HTTP POST request to the /repositories/settings/validate endpoint.
HTTP Request
POST https://<hostname>/api/v2/repositories/settings/validate |
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. |
Request Body
To check whether the settings you plan to specify for a repository are valid., send the following parameter in the request body.
Parameter | Type | Description |
|---|---|---|
azureStorageAccountId | string | Azure ID assigned to an Azure storage account where the blob container resides. |
azureStorageFolder | string | Name of the folder in the selected blob container used to store Azure VM backups. |
azureStorageContainer | string | Azure ID assigned to a blob container where the repository is located. |
azureAccountId | string | Azure ID assigned to an Azure account whose permissions are used to connect to a repository. |
storageTier | array[string] | Specifies the type of selected access tier: Inferred, Hot, Cool. |
name | string | Specifies a name of a repository. |
description | string | Description of a repository. |
enableEncryption | boolean | Defines whether to enable encryption for backup files stored in the created repository. |
password | string | [Applies only if encryption is enabled] Specifies a password that Veeam Backup for Microsoft Azure will use for encryption. |
hint | string | [Applies only if encryption is enabled] Specifies a hint for the specified password. |
Set the parameter value in the following format:
{ "azureStorageAccountId": "string", "azureStorageFolder": "string", "azureStorageContainer": "string", "azureAccountId": "string", "storageTier": "Inferred", "name": "string", "description": "string", "enableEncryption": true, "password": "string", "hint": "string" } |
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
If repository settings are valid, Veeam Backup for Microsoft Azure does not return a response body, in other cases Veeam Backup for Microsoft Azure returns the severity level and the error message.
Example
The following request checks new repository settings.
|