This is an archive version of the document. To get the most up-to-date information, see the current version.Adding Backup Repositories
This section explains how to add backup repositories to the Veeam Backup for Microsoft Azure environment.
Request
POST https://<hostname>/api/v1/repositories |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
None.
Request Body
Property | Type | Description |
name | string | Sets the name of the backup repository. |
description | string | Sets the description of the backup repository. |
enableEncryption | boolean | Enables/disables encryption. |
password | string | Sets the password to be used to encrypt data. |
hint | string | Sets the password hint. |
azureStorageAccountId | string | Sets the identification number of the Azure store account. |
azureStorageFolder | string | Sets the folder to be used to keep backups. |
azureStorageContainer | string | Sets the Azure container. |
azureConnectionId | string | Sets the connection identification number. |
Request Example
Request: POST https://<hostname>/api/v1/repositories
Request Header: Authorization: Bearer <Access-Token>
Request Body: { "name":"Backup Repository", "description":"", "enableEncryption":true, "password":"xxxxx", "hint":"Hint", "azureStorageAccountId":"6s9rdnmvdsnmebudp49abg8gg44k3t4huhka9anrca1smd9u8wwo", "azureStorageFolder":"OSRv3", "azureStorageContainer":"container3", "azureConnectionId":9 } |
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 HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
The response contains the following information.
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the session. |
type | string | Shows the type of the session. |
executionStartTime | string | Shows at what time the session was started. |
executionDuration | string | Shows the duration of the session. |
status | string | Shows the status of the session. |
usn | string | Shows the version of the backup policy. Used by platform services to detect if a backup policy has been hanged since the last sync. |
repositoryJobInfo | Contains the RepositoryJobInfo object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
repositoryId | integer | Shows the identification number of the backup repository. |
repositoryName | string | Shows the name of the backup repository. |
repositoryRemoved | boolean | Shows if the backup repository is removed. |
Response Example
Response: 200 OK
Response Body: { "id": "35", "type": "RepositoryCreation", "executionStartTime": "2020-02-05T09:16:48.3880849Z", "executionDuration": "00:00:00.0007395", "status": "Running", "usn": 0, "repositoryJobInfo": { "repositoryId": 4, "repositoryName": "Backup Repository", "repositoryRemoved": false }, "_links": { "self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/35"}, "log": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/35/log"} } } |