Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

System

The /system resource collection provides information on the Veeam Backup for Microsoft Azure system configuration.

Get System Logs

The HTTP GET request to the /system/logs endpoint retrieves Veeam Backup for Microsoft Azure system logs.

x-veeam-custom-response: true
SecurityBearer
Request
query Parameters
ExportLogsType
required
string (ExportLogsType)

Returns only logs of the specified type.

Enum: "LastDays" "BetweenDates" "Unknown"
x-veeam-parameter-group: ExportLogsOptions
Days
integer or null <int32>

Returns logs created in the specified period (in days).

x-veeam-parameter-group: ExportLogsOptions
FromDateUtc
string or null <date-time>

Returns logs created after the specified date and time.

x-veeam-parameter-group: ExportLogsOptions
ToDateUtc
string or null <date-time>

Returns logs created before the specified date and time.

x-veeam-parameter-group: ExportLogsOptions
Responses
200

OK

201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/system/logs
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/system/logs?ExportLogsType=LastDays&Days=0&FromDateUtc=2019-08-24T14%3A15%3A22Z&ToDateUtc=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "detail": "string",
  • "errors": {
    },
  • "status": 0,
  • "title": "string",
  • "traceId": "string",
  • "type": "string"
}

Get Product Details

The HTTP GET request to the /system/about endpoint retrieves Veeam Backup for Microsoft Azure system information.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/system/about
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/about \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "serverVersion": "string",
  • "workerVersion": "string",
  • "flrVersion": "string",
  • "databaseId": "d0f4f849-8ecf-4909-96bf-7953790e45f9",
  • "copyright": "string",
  • "deploymentSubscriptionId": "string"
}

Get Appliance Details

The HTTP GET request to the /system/serverInfo endpoint retrieves detailed information on the Azure VM running the backup appliance.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/system/serverInfo
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/serverInfo \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "subscriptionId": "d079718b-ff63-45dd-947b-4950c023750f",
  • "serverName": "string",
  • "azureRegion": "string",
  • "azureRegionName": "string",
  • "azureVmId": "string",
  • "resourceGroup": "string",
  • "azureEnvironment": "Global",
  • "virtualMachineUniqueId": "string",
  • "DisabledSections": {
    }
}

Get Current Time Zone

The HTTP GET request to the /system/time endpoint retrieves the current time zone in which backup appliance is operating.

SecurityBearer
Responses
200

OK

401

Unauthorized

get/api/v8/system/time
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/time \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "utcDateTime": "2019-08-24T14:15:22Z",
  • "timeZone": "string"
}

Get Collection of Time Zones

The HTTP GET request to the /system/timezones endpoint retrieves a list of time zones that can be set for the backup appliance.

SecurityBearer
Responses
200

OK

401

Unauthorized

get/api/v8/system/timezones
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/timezones \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Set Time Zone

The HTTP PUT request to the /system/timezone endpoint changes the time zone in which backup appliance is operating.

SecurityBearer
Request
Request Body schema: application/json
required
timezoneId
string

Specifies the system ID assigned to the time zone in the Veeam Backup for Microsoft Azure REST API.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

put/api/v8/system/timezone
Request samples
application/json
{
  • "timezoneId": "string"
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}

Get Update Status

The HTTP GET request to the /system/status endpoint retrieves the status of backup appliance after update.

SecurityBearer
Responses
200

OK

401

Unauthorized

get/api/v8/system/status
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/status \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "state": "Ready",
  • "serverTime": "2019-08-24T14:15:22Z"
}

Get Support Info

The HTTP GET request to the /system/supportInfo endpoint retrieves the tenant ID and a support code.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/system/supportInfo
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/supportInfo \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "azureTenantId": "string",
  • "supportCode": "string"
}

Get Deployment Mode

The HTTP GET request to the /system/privateDeployment/state endpoint retrieves the state of the private network deployment functionality as well as other Deployment Mode settings.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

409

Conflict

get/api/v8/system/privateDeployment/state
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/privateDeployment/state \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "messageService": "ServiceBus",
  • "privateDeploymentEnabled": true,
  • "privateDnsZoneSetting": "Disabled",
  • "privateDnsZoneResourceGroupId": "string",
  • "autoCreateServiceEndpoints": true,
  • "isUpdating": true,
  • "error": "string"
}

Configure Deployment Mode

The HTTP PUT request to the /system/privateDeployment/state allows you to choose a messaging service that will be used to transfer data, enable or disable the private network deployment functionality, and enable or disable automatic creation of service endpoints.

SecurityBearer
Request
Request Body schema: application/json
required
privateDeploymentEnabled
required
boolean

Defines whether to enable or disable the private network deployment functionality.

autoCreateServiceEndpoints
required
boolean

Defines whether to enable or disable automatic creation of service endpoints for the Microsoft.Storage.Global service to communicate with worker instances in public virtual networks.

privateDnsZoneSetting
string or null (PrivateDnsSetting)

Specifies the private DNS zone settings:

  • If you select the Disabled value, you must do the following: create the DNS zones, add to the DNS zones A records for the private endpoints of disk access resources and Veeam storage accounts, and add to the DNS zones the VNet to which the backup appliance is connected and the VNet to which worker instances are connected.
  • If you select the ManageARecords value, you must create the DNS zones and add to these DNS zones the VNet to which the backup appliance is connected and the VNet to which worker instances are connected, while Veeam Backup for Microsoft Azure will automatically add to the DNS zones A records for the private endpoint of disk access resources and Veeam storage accounts.
  • If you select the ManageAutomatically value, Veeam Backup for Microsoft Azure will automatically create the DNS zones in the resource group to which worker instances belong, add to these DNS zones A records for the private endpoint of disk access resources and Veeam storage accounts, and add to the DNS zones the VNet to which the backup appliance is connected and the VNet to which worker instances are connected.
NOTE
Regardless of the value you selected for the PrivateDnsSetting parameter, you must configure peering connections between the VNet to which the backup appliance is connected and the VNet to which worker instances are connected. For more information, see the Veeam Backup for Microsoft Azure User Guide.

Enum: "Disabled" "ManageAutomatically" "ManageARecords"
privateDnsZoneResourceGroupId
string or null

[Applies only if you have selected the ManageARecords value for the privateDnsZoneSetting parameter] Specifies the Microsoft Azure ID assigned to the resource group to which the private DNS zones that will be used for private network deployment belong or in which these DNS zones will be created.

Responses
202

Accepted

401

Unauthorized

403

Forbidden

409

Conflict

put/api/v8/system/privateDeployment/state
Request samples
application/json
{
  • "privateDeploymentEnabled": true,
  • "privateDnsZoneSetting": "Disabled",
  • "privateDnsZoneResourceGroupId": "string",
  • "autoCreateServiceEndpoints": true
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Check State of Services

The HTTP GET request to the /system/serviceIsUp endpoint checks whether Veeam Backup for Microsoft Azure services are ready to work.

SecurityBearer
Responses
200

OK

get/api/v8/system/serviceIsUp
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/system/serviceIsUp \
  -H 'Authorization: YOUR_API_KEY_HERE'