Veeam Backup & Replication 13
REST API Reference
Related documents

License

The License section defines paths and operations for installing and managing licenses on the backup server.

Install License

The HTTP POST request to the /api/v1/license/install path allows you to install a license on the backup server.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Request Body schema: application/json
required
license
required
string

Base64-encoded string of the content of a license file.

forceStandaloneMode
boolean

This property is only used with backup servers managed by Veeam Backup Enterprise Manager.

  • If true, license will be installed.
  • If false or the property is not specified, the request will return an error, warning you that the backup server is managed by Enterprise Manager.

object (LicenseInstallationPromoSpec)

Promo license installation settings.

Responses
200

OK

400

Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

post/api/v1/license/install
Request samples
application/json
{
  • "license": "PD94bWwgdmVyc2lvbj0iMGoeDiBlbmNvZGluZz0iVVRGLTgiPz4KPExpY2Vuc2VzPjxMaWNlbnNlPjwhW0NEQVRBW0FkZGl0aW9uYWwgU2lnbmF0dXJlPTM0NkJBRDM0NjE3QUJCOEU1NDJFQkJGQ0QyRTczMjQ4QjIzNjcwQjExQTM1MTdEODA5RURDMEQ0MERFNDJDMTU5QzZCNTdDRTRGOEUxMjA2NDE2NzQ2ODg4QjM4RDc2ODY2NzcwM0Y3NTU2NzU0MkM4MjU2NTdBOTFCREY4QkIwOEE4ODJDRkQwNjdCNjU4NjZDMjBBOTc4MjYwOURCQzg3QUQ1ODRENjU5MzczRkNGRkI5NDc5M0RGRjk2MEVCOTNGRTlFRTU4NDcxREQ3Q0U5M0JEOUM5OEIxQUM5NzI3MjRCMUIxMUM5QUM5QzUyQTdCNEQwRDcxQUI3N0RCRDY2MTY0Q0YzREUwMzJDMjBBNUZCQjdFOTMyRkI3QzRCQjM1NkI3NkJCNkM2NEVENDdGNzlDMzE1NTMzNTI3QzNERkYzMEM2QUU4RjQxRjU5MTYxOUMyQTQ1NDk4RUQwOTQwRjZDQTA4NDQ4QzgyNTcwNTg1ODM0ODNBMTdBRThCQUE1QkUyQ0UxQUM3MkJGRDcyNTY5NUZEQzI2OTM0N0U0NENENUE0ODJDMDM4QjhCQkU4RjM1MkQ5MzFGQjU2NzM4RkI5MTcwODU3QUQ2RDQ2N0RBODI4NzY2MzI4ODY4MDAxRkE1NURFRUNCMjUzMzFDRTQzMUIwNzYwNTJFNzIxNkNFODBFMkZENDk4RUQ5RUEwM0E0NzVBNzkxN0RGNzY0QUYwRkNDNUE3M0Y4N0ZGNzg5RkZGRjRGRjlEQkNFNjMyMDU3RDM0REQyNEY2RTMwNEJGMEUzMDM3NEU0RTY4MTlDMjhGMTVDMjIwRUZCODNEMjdENjQzMDdGNjkwRTA1QkM4M0U5QzFDREMwMzJCQTczMjk2RTRDQTZBMjBDMzM1RjE3NTQwRjk2NTZFOTVGMTA1NUQzQzQ5Qjk1RTIyODZCQzY1OEI2MjU4QTIxMDMyMTgxRTk5RTIzRjg1MzdDMjdFNEE4NjcxQjgwRDc5RTQ4M0U2RTZFNjRDOTkzMQpDbG91ZCBDb25uZWN0PUVudGVycHJpc2UKQ29tcGFueT1WZWVhbSBTb2Z0d2FyZSBHcm91cCBHbWJICkRlc2NyaXB0aW9uPUNvcHlyaWdodCAyMDIzIFZlZWFtIFNvZnR3YXJlIEdyb3VwIEdtYkguIEFsbCBSaWdodHMgUmVzZXJ2ZWQuIFVzZSBvZiBzb2Z0d2FyZSBpcyBnb3Zlcm5lZCBieSB0aGUgc29mdHdhcmUgbGljZW5zZSBhZ3JlZW1lbnQuCkUtbWFpbD1yZEB2ZWVhbS5jb20KSW5zdGFuY2VzPTEwMApMaWNlbnNlIElEPTExMTEyMjIyLTExMTEtMjIyMi0zMzMzLTExMTEyMjIyMzMzMwpMaWNlbnNlIGV4cGlyZXM9MzEvMTIvMjAyNApMaWNlbnNlIHR5cGU9U3Vic2NyaXB0aW9uClBhY2thZ2U9U3VpdGUKU3VwcG9ydCBJRD0wMjA2Nzc2MgpTaWduYXR1cmU9MThDMTcxN0NCMjFBNEU3QkI2RTg5Q0NDREJFMTlBQzY4N0IwNUFDMDRDNzY0RkExODI0NUQxMjgzOEQ0NjUxQjUwNTYzMUVERUNENDBBNzFGODNEQUNGNjRGNkYzQUJFOUNBMzYxMUZDNUM0NjFBNUJBMjhEM0M4RTVGMDRBMEFFQ0UyNDc2REE0MzY2RDQyRkFGQUU0MDYyN0M2RDM4ODEzOERCRDUzQzgzNzE4MEIzMkU1NEE0NDcwN0U5OENCRkJDQkVDMUM5MTExQkEyQzFBQTM2RDVDNzE4RjgxQjA2RkJEQjMzOTA5RUI1ODMxMzkxQTk4MzhDNEY5RTI0OApdXT48L0xpY2Vuc2U+PC9MaWNlbnNlcz4K"
}
Response samples
application/json
{
  • "status": "Valid",
  • "type": "Subscription",
  • "edition": "EnterprisePlus",
  • "cloudConnect": "Disabled",
  • "expirationDate": "2026-12-12T00:00:00Z",
  • "licensedTo": "Veeam Software Group GmbH",
  • "instanceLicenseSummary": {
    },
  • "supportId": "02067762",
  • "autoUpdateEnabled": true,
  • "freeAgentInstanceConsumptionEnabled": true,
  • "IsMultiSection": false,
  • "proactiveSupportEnabled": true
}

Get Installed License

The HTTP GET request to the /api/v1/license path allows you to get the installed license on the backup server.

Available to: Veeam Backup Administrator.

SecurityBearer
Request
header Parameters
x-api-version
required
string
Default: 1.3-rev0

Version and revision of the client REST API. Must be in the following format: <version>-<revision>.

Responses
200

OK

401

Unauthorized. The authorization header has been expected but not found (or found but is expired).

403

Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.

500

Internal server error. The request has been received but could not be completed because of an internal error at the server side.

get/api/v1/license
Request samples 
Response samples 
application/json
{
  • "status": "Valid",
  • "type": "Subscription",
  • "edition": "EnterprisePlus",
  • "cloudConnect": "Disabled",
  • "expirationDate": "2026-12-12T00:00:00Z",
  • "licensedTo": "Veeam Software Group GmbH",
  • "instanceLicenseSummary": {
    },
  • "supportId": "02067762",
  • "autoUpdateEnabled": true,
  • "freeAgentInstanceConsumptionEnabled": true,
  • "IsMultiSection": false,
  • "proactiveSupportEnabled": true
}
Remove License
The HTTP POST request to the /api/v1/license/remove path allows you to remove a license from the backup server.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
forceStandaloneMode
boolean
This property is only used with backup servers managed by Veeam Backup Enterprise Manager.
  • If true, the license will be removed. 
  • If false or the property is not specified, the request will return an error, warning you that the backup server is managed by Enterprise Manager.


 
section
string (ELicenseSectionType) 
Type of the removed license.


 Enum: "All" "Instance" "Socket"  
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/remove
Request samples 
application/json
{
  • "section": "Socket"
}
Response samples 
application/json
{
  • "status": "Valid",
  • "type": "Subscription",
  • "edition": "EnterprisePlus",
  • "cloudConnect": "Disabled",
  • "expirationDate": "2026-12-12T00:00:00Z",
  • "licensedTo": "Veeam Software Group GmbH",
  • "instanceLicenseSummary": {
    },
  • "supportId": "02067762",
  • "autoUpdateEnabled": true,
  • "freeAgentInstanceConsumptionEnabled": true,
  • "IsMultiSection": false,
  • "proactiveSupportEnabled": true
}
Create License Usage Report
The HTTP POST request to the /api/v1/license/createReport path allows you to create a license usage report for the backup server.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
reportFormat
required
string (ELicenseReportFormat) 
Format of the license usage report.


 Enum: "Html" "Pdf" "Json"  
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/createReport
Request samples 
application/json
{
  • "reportFormat": "Html"
}
Response samples 
application/octet-stream
{
  "products": [
    {
      "productVersion": "12.3.0.291",
      "edition": "Enterprise Plus",
      "installationId": "01d17da0-a5ee-4969-9f36-2dc80bf03ee6",
      "data": [
        {
          "instances": {
            "supportId": "02067762",
            "licenseId": "11112222-1111-2222-3333-111122223333",
            "licenseType": "Subscription",
            "counters": [
              {
                "counterType": "VBR-VBR-APPLICATION-PLUGIN",
                "multiplier": "1",
                "instancesInGrace": "0",
                "numberOfObjects": 1,
                "numberOfNewObjects": 0,
                "numberOfRentalObjects": 0,
                "numberOfRemovedObjects": 0,
                "consumedInstances": "1",
                "newInstances": "0",
                "rentalInstances": "0",
                "removedInstances": "0",
                "reasonForRemoval": ""
              },
              {
                "counterType": "VBR-VBR-VM-VSPHERE",
                "multiplier": "1",
                "instancesInGrace": "0",
                "numberOfObjects": 1,
                "numberOfNewObjects": 0,
                "numberOfRentalObjects": 0,
                "numberOfRemovedObjects": 0,
                "consumedInstances": "1",
                "newInstances": "0",
                "rentalInstances": "0",
                "removedInstances": "0",
                "reasonForRemoval": ""
              }
            ]
          }
        }
      ]
    }
  ]
}
Renew Installed License
The HTTP POST request to the /api/v1/license/renew path allows you to renew the license on the backup server.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
forceStandaloneMode
boolean
This property is only used with backup servers managed by Veeam Backup Enterprise Manager.
  • If true, license will be renewed. 
  • If false or the property is not specified, the request will return an error, warning you that the backup server is managed by Enterprise Manager.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/renew
Request samples 
application/json
{
  • "forceStandaloneMode": true
}
Response samples 
Get Consumption of Socket Licenses
The HTTP GET request to the /api/v1/license/sockets path allows you to get information about the consumption of socket licenses on the backup server.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of workloads to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of workloads to return.


 
orderColumn
string (ESocketWorkloadsFiltersOrderColumn) 
Sorts workloads by one of the socket workload parameters.


 Enum: "Name" "HostName" "HostId" "SocketsNumber" "CoresNumber" "Type"  
orderAsc
boolean
If true, sorts workloads in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters workloads by the nameFilter pattern. The pattern can match any workload parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
hostNameFilter
string
Filters workloads by hostname.


 
hostIdFilter
string <uuid> 
Filters workloads by host ID.


 
socketsNumberFilter
integer
Filters workloads by the number of sockets they use.


 
coresNumberFilter
integer
Filters workloads by the number of CPU cores they use.


 
typeFilter
string (ESocketLicenseObjectType) 
Filters workloads by host type.


 Enum: "HyperV" "Universal" "Unlicensed" "vSphere"  
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/license/sockets
Request samples 
Response samples 
application/json
{
  • "data": {
    },
  • "pagination": {
    }
}
Revoke Socket License
The HTTP POST request to the /api/v1/license/sockets/{hostId}/revoke path allows you to revoke a socket license from the host with the specified hostId.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
hostId
required
string <uuid> 
ID of the licensed host. To get the host ID, run the Get Installed License request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/sockets/{hostId}/revoke
Request samples 
Response samples 
application/json
{
  • "type": "vSphere",
  • "name": "prgtwesx01.tech.local",
  • "hostName": "prgtwesx01.tech.local",
  • "hostId": "a6ca6129-5c58-47e3-b35c-ff1187d88ee4",
  • "socketsNumber": 2,
  • "coresNumber": 16
}
Get Instance Licenses Consumption
The HTTP GET request to the /api/v1/license/instances path allows you to get information about instance license consumption on the backup server.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
query Parameters
skip
integer <int32> 
Number of workloads to skip.


 
limit
integer <int32> 
 Default:  200
Maximum number of workloads to return.


 
orderColumn
string (EInstanceWorkloadsFiltersOrderColumn) 
Sorts workloads by one of the workload parameters.


 Enum: "Name" "HostName" "UsedInstancesNumber" "Type" "InstanceId"  
orderAsc
boolean
If true, sorts workloads in the ascending order by the orderColumn parameter.


 
nameFilter
string
Filters workloads by the nameFilter pattern. The pattern can match any instance workload parameter. To substitute one or more characters, use the asterisk (*) character at the beginning, at the end or both.


 
hostNameFilter
string
Filters workloads by hostname.


 
usedInstancesNumberFilter
number <double> 
Filters workloads by the number of consumed instances.


 
typeFilter
string
Filters workloads by workload type.


 
instanceIdFilter
string <uuid> 
Filters workloads by instance ID.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/license/instances
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}
Assign Instance License
The HTTP POST request to the /api/v1/license/instances/{instanceId}/assign path allows you to set the product edition for a standalone Veeam Agent with the specified instanceId.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
instanceId
required
string <uuid> 
Instance ID. To get the instance ID, run the Get Installed License request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
role
required
string (EInstanceLicenseWorkloadRole) 
Product edition that you want to assign to the standalone Veeam Agent.


 Enum: "Workstation" "Server"  
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/instances/{instanceId}/assign
Request samples 
application/json
{
  • "role": "Workstation"
}
Response samples 
application/json
{
  • "name": "linbase02",
  • "hostName": "Standalone",
  • "usedInstancesNumber": 1,
  • "type": "Server",
  • "instanceId": "4225c1d4-e095-92db-d123-2d635a38c390"
}
Revoke Instance License
The HTTP POST request to the /api/v1/license/instances/{instanceId}/revoke path allows you to revoke an instance license from the workload that has the specified instanceId.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
instanceId
required
string <uuid> 
Instance ID. To get the instance ID, run the Get Installed License request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/instances/{instanceId}/revoke
Request samples 
Response samples 
application/json
{
  • "name": "winsrv88:/C:\\Shares\\nfs_share",
  • "hostName": "winsrv88",
  • "usedInstancesNumber": 0,
  • "type": "FileShare",
  • "instanceId": "0405a174-dc1a-473a-a2cf-b5b1c8b1b620"
}
Remove Instance License
The HTTP POST request to the /api/v1/license/instances/{instanceId}/remove path allows you to remove a licensed Agent instance from the workload that has the specified instanceId.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
instanceId
required
string <uuid> 
Instance ID. To get the instance ID, run the Get Installed License request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/instances/{instanceId}/remove
Request samples 
Response samples 
application/json
{
  • "name": "linbase02",
  • "hostName": "Standalone",
  • "usedInstancesNumber": 1,
  • "type": "Server",
  • "instanceId": "4225c1d4-e095-92db-d123-2d635a38c390"
}
Get Capacity License Consumption
The HTTP GET request to the /api/v1/license/capacity path allows you to get information about the capacity license instance consumption by file shares and object storages. 
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


get/api/v1/license/capacity
Request samples 
Response samples 
application/json
{
  • "workloads": [
    ]
}
Revoke Capacity License From Unstructured Data Workload
The HTTP POST request to the /api/v1/license/capacity/{instanceId}/revoke path allows you to revoke a capacity instance with the specified instanceId from an unstructured data workload (file share or object storage). 
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
path Parameters
instanceId
required
string <uuid> 
Instance ID. To get the instance ID, run the Get Installed License request.


 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/capacity/{instanceId}/revoke
Request samples 
Response samples 
application/json
{
  • "workloads": [
    ]
}
Update License
The HTTP POST request to the /api/v1/license/update path allows you to manually update your license.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/update
Request samples 
Response samples 
application/json
{
  • "message": "Veeam Backup and Replication:\n License key is up-to-date",
  • "isSuccessful": true
}
Enable or Disable License Auto Update
The HTTP POST request to the /api/v1/license/autoupdate allows you to enable or disable automatic update of the installed license.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
enabled
required
boolean
If true, the license is automatically updated.


 
proactiveSupportEnabled
boolean
If true, proactive support is enabled. This option periodically shares anonymized, non-sensitive backup infrastructure details with Veeam.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/autoupdate
Request samples 
application/json
{
  • "enabled": true,
  • "proactiveSupportEnabled": true
}
Response samples 
application/json
{
  • "status": "Valid",
  • "type": "Subscription",
  • "edition": "EnterprisePlus",
  • "cloudConnect": "Disabled",
  • "expirationDate": "2026-12-12T00:00:00Z",
  • "licensedTo": "Veeam Software Group GmbH",
  • "instanceLicenseSummary": {
    },
  • "supportId": "02067762",
  • "autoUpdateEnabled": true,
  • "freeAgentInstanceConsumptionEnabled": true,
  • "IsMultiSection": false,
  • "proactiveSupportEnabled": true
}
Enable or Disable Instance Consumption for Unlicensed Agents
The HTTP POST request to the /api/v1/license/agentConsumption allows you to enable or disable unlicensed standalone agents to consume instances.
Available to: Veeam Backup Administrator.


SecurityBearer 
Request 
header Parameters
x-api-version
required
string
 Default:  1.3-rev0
Version and revision of the client REST API. Must be in the following format: <version>-<revision>.


 
Request Body schema: application/json
required
enabled
required
boolean
If true, unlicensed standalone Veeam Agents consume instances.


 
Responses 
200
OK


400
Bad request. This error is related to POST/PUT requests. The request body is malformed, incomplete or otherwise invalid.


401
Unauthorized. The authorization header has been expected but not found (or found but is expired).


403
Forbidden. The user sending the request does not have adequate privileges to access one or more objects specified in the request.


500
Internal server error. The request has been received but could not be completed because of an internal error at the server side.


post/api/v1/license/agentConsumption
Request samples 
application/json
{
  • "enabled": true
}
Response samples 
application/json
{
  • "status": "Valid",
  • "type": "Subscription",
  • "edition": "EnterprisePlus",
  • "cloudConnect": "Disabled",
  • "expirationDate": "2026-12-12T00:00:00Z",
  • "licensedTo": "Veeam Software Group GmbH",
  • "instanceLicenseSummary": {
    },
  • "supportId": "02067762",
  • "autoUpdateEnabled": true,
  • "freeAgentInstanceConsumptionEnabled": true,
  • "IsMultiSection": false,
  • "proactiveSupportEnabled": true
}