Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

License

The /license resource collection represents Veeam Backup for Microsoft Azure license information, license usage data and configured notifications on license usage and expiration.

Get License Details

The HTTP GET request to the /license endpoint retrieves information on the installed Veeam Backup for Microsoft Azure license.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

get/api/v8/license
Request samples 
curl -i -X GET \
  https://123.123.123.123/api/v8/license \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "licenseType": "Subscription",
  • "isFreeEdition": true,
  • "totalInstancesUses": 0,
  • "vmsInstancesUses": 0,
  • "sqlInstancesUses": 0,
  • "fileShareInstancesUses": 0,
  • "cosmosDbInstancesUses": 0,
  • "instances": 0,
  • "company": "string",
  • "email": "string",
  • "licenseExpires": "2019-08-24T14:15:22Z",
  • "licenseId": "string",
  • "supportId": "string",
  • "gracePeriodDays": 0,
  • "veeamOnlineStoreUrl": "string",
  • "licensingServer": {
    }
}

Remove License

The HTTP DELETE request to the /license endpoint removes a license installed on the backup appliance if it is no longer needed.

SecurityBearer
Responses
200

OK

401

Unauthorized

403

Forbidden

delete/api/v8/license
Request samples 
curl -i -X DELETE \
  https://123.123.123.123/api/v8/license \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "licenseType": "Subscription",
  • "isFreeEdition": true,
  • "totalInstancesUses": 0,
  • "vmsInstancesUses": 0,
  • "sqlInstancesUses": 0,
  • "fileShareInstancesUses": 0,
  • "cosmosDbInstancesUses": 0,
  • "instances": 0,
  • "company": "string",
  • "email": "string",
  • "licenseExpires": "2019-08-24T14:15:22Z",
  • "licenseId": "string",
  • "supportId": "string",
  • "gracePeriodDays": 0,
  • "veeamOnlineStoreUrl": "string",
  • "licensingServer": {
    }
}

Get Azure Resources Consuming License Units

The HTTP GET request to the /license/resources endpoint retrieves information on Azure resources that are currently protected by backup policies.

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
SearchPattern
string or null

Returns only those items of a resource collection that match the specified search pattern in the parameter value.

x-veeam-parameter-group: LicenseReportOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/license/resources
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/license/resources?Offset=0&Limit=-1&SearchPattern=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "offset": 0,
  • "limit": 0,
  • "totalCount": 0,
  • "_links": {},
  • "results": [
    ]
}

Export License Usage Report

The HTTP POST request to the /license/export endpoint exports the license usage report to a .CSV or an .XML file.

x-veeam-custom-response: true
SecurityBearer
Request
header Parameters
Accept
string or null

Specifies a media type of representation of the exported data. The default value is text/csv media type.

Request Body schema: application/json
licensedResourceIds
Array of strings or null <uuid>

Specifies a list of system IDs assigned in the Veeam Backup for Microsoft Azure REST API to the license units consumed by Azure resources.

Responses
200

OK

401

Unauthorized

403

Forbidden

post/api/v8/license/export
Request samples
application/json
{
  • "licensedResourceIds": [
    ]
}
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "type": "string",
  • "licenseAgreementAcceptanceRequired": true
}

Remove Licensing Server

The HTTP DELETE request to the /license/licensingServer endpoint removes the backup appliance from the Veeam Backup & Replication license.

SecurityBearer
Responses
204

No Content

401

Unauthorized

403

Forbidden

delete/api/v8/license/licensingServer
Request samples 
curl -i -X DELETE \
  https://123.123.123.123/api/v8/license/licensingServer \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/problem+json
{
  • "extensions": { },
  • "status": 0,
  • "title": "string",
  • "detail": "string",
  • "type": "string"
}