Licensing

This resource collection represents currently installed license and license usage.

Get License

Returns a resource representation of a license installed on a Veeam ONE server.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/license

Request samples

curl

Response samples

application/json

{"type": "Evaluation",
"expirationDate": "2024-01-01T00:00:00Z",
"supportExpirationDate": null,
"instances": 10000,
"sockets": 0,
"package": "Suite",
"company": "Veeam Software Group GmbH",
"email": "j.smith@alpha.com",
"supportId": "",
"licenseId": "2235378f-bd8f-5b9e-b5c0-bce99f7e05a0"
}

Get License Usage

Returns a resource representation of license usage by Veeam ONE.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/license/currentUsage

Request samples

curl

Response samples

application/json

{"units": [{"licenseUnit": "Instances",
"used": "379",
"available": "9621",
"licensed": "10000"
}
]
}

Get License Usage by Managed Workloads

Returns a resource representation of license usage by managed workloads.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/license/currentUsage/details

Request samples

curl

Response samples

application/json

{"unitsType": "Instances",
"workloads": [{"workloadType": "VMs (VMware vSphere)",
"usedObjects": 312,
"newObjects": 0,
"usedUnits": 312,
"newUnits": 0,
"multiplier": 1
},
{"workloadType": "VMs (Microsoft Hyper-V)",
"usedObjects": 14,
"newObjects": 0,
"usedUnits": 14,
"newUnits": 0,
"multiplier": 1
},
{"workloadType": "VMs (Nutanix AHV)",
"usedObjects": 7,
"newObjects": 0,
"usedUnits": 7,
"newUnits": 0,
"multiplier": 1
}
]
}

Get License Usage Report

Returns a resource representation of a license usage report. Available only for Rental license.

SecurityBearer

Responses

200

Success

403

Forbidden

422

Unprocessable Content

get/api/v2.3/license/usageReport

Request samples

curl

Response samples

application/json

{"date": "2025-07-01T00:00:00Z",
"status": "Draft",
"approvalDate": null,
"totalWorkloads": 326,
"reportId": 1,
"removalReason": "",
"workloads": [{"workloadType": "VMs (VMware vSphere)",
"usedObjects": 312,
"newObjects": 0,
"usedUnits": 312,
"newUnits": 0,
"removedObjects": 0,
"removedUnits": 0,
"multiplier": 1
},
{"workloadType": "Servers (Microsoft Windows)",
"usedObjects": 14,
"newObjects": 0,
"usedUnits": 14,
"newUnits": 0,
"removedObjects": 0,
"removedUnits": 0,
"multiplier": 1
}
]
}

Approve License Usage Report

Approves a license usage report.

SecurityBearer

Request

Request Body schema: application/json

reportId	integer <int32> ID assigned to a license usage report.
removalReason	string or null Reason for the removal of a licensed object.
	Array of objects or null (VeeamOneLicenseUsageReportApproveWorkload) Array of managed workloads.

Responses

200

Success

400

Bad Request

403

Forbidden

422

Unprocessable Content

post/api/v2.3/license/usageReport

Request samples

Payload
curl

application/json

{"reportId": 0,
"removalReason": "Workloads temporary added for POC",
"workloads": [{"workloadType": "Virtual Machines",
"usedObjects": 325
}
]
}

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get License Settings

Returns a resource representation of license settings.

SecurityBearer

Responses

200

Success

403

Forbidden

get/api/v2.3/license/settings

Request samples

curl

Response samples

application/json

{"autoUpdateEnabled": true,
"managedMode": false
}

Apply License Settings

Applies specific license settings.

SecurityBearer

Request

Request Body schema: application/json

autoUpdateEnabled	boolean Indicates whether auto-update is enabled for a license.
managedMode	boolean Indicates whether some other service provides statistics instead of Veeam ONE.

Responses

200

Success

400

Bad Request

403

Forbidden

post/api/v2.3/license/settings

Request samples

Payload
curl

application/json

{"autoUpdateEnabled": true,
"managedMode": false
}

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Update License

Downloads a new license from the Veeam License Update Server and installs it on the Veeam ONE server.

SecurityBearer

Responses

200

Success

403

Forbidden

patch/api/v2.3/license/update

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Delete License

Deletes a license from the Veeam ONE server.

SecurityBearer

Responses

200

Success

403

Forbidden

post/api/v2.3/license/remove

Request samples

curl

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Install License

Installs a license file in the Base64 format on the Veeam ONE server.

SecurityBearer

Request

Request Body schema: application/json

license

required

string <byte>

License file in the Base64 format.

Responses

200

Success

400

Bad Request

403

Forbidden

post/api/v2.3/license/install

Request samples

Payload
curl

application/json

{"license": "TY3b6YlwpL5chwjlwaU/6iumTyHhtaxnBUsZY027YFmUiiGCOzgOToHonJpro4TM8cYJMa8/pTGmiMdCKc1tAUxUnvPfWuvKwXEuxX03ivfB1/8e5OUpkaxmPczAxhSZsafTC66BlF0X8D37PjCxZK6J46DOQ0HVK+9kZx5LwWiwIxVrJASvqijBTqHC91XQInScihoi0otjEE968p6Z5pXdDPeEuTzYQjA46gY5r/j6P8NSJAmyjtuzSX+KpQQb12a2EAs3rHHSYBd6nh9FzizGPQNi3d5ntyEOGE0LKz36wIRE7fGpr2w6YBFwoYusCa2Gvvd2MksN5CsolvYB"
}

Response samples

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}