This is an archive version of the document. To get the most up-to-date information, see the current version.Get Backup Appliance Data
You can get the information on backup appliance.
Request
To retrieve the information on backup appliance, send the HTTP GET request to the /system/serverInfo endpoint.
HTTP Request
GET https://<hostname>/api/v3/system/serverInfo |
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 the current version of Veeam Backup for Microsoft Azure.
Parameter | Type | Description |
|---|---|---|
subscriptionId | string($uuid) | Specifies the Azure subscription where the backup appliance belongs. |
serverName | string | Specifies the name of the backup appliance. |
azureRegion | string | Specifies an Azure region where the backup appliance resides. |
azureVmId | string | Azure ID assigned to the Azure VM running Veeam Backup for Microsoft Azure. |
resourceGroup | string | Specifies a resource group ti which the backup appliance belongs. |
azureEnvironment | array[string] | Type of Microsoft Azure environment where the backup appliance resides: Global, Germany, China, USGovernment. |
virtualMachineUniqueId | string | System ID assigned in the backup infrastructure to the Azure VM running Veeam Backup for Microsoft Azure. |
Example
The following request returns the information on the backup appliance.
|