License usage

Query the installed license types and their usage.

Breakdown of installed licenses

Query the license types installed on your space, and their current usage.

Request

GET .../api/shared_spaces/<space_id>/tenant_licenses

Response

"total_count": 14,
"data": [{
	"type": "license",
	"id": "1001",
	"license_id": "123101",
	"expiration_date": "2024-08-31T23:59:59Z",
	"start_date": "2024-06-20T00:00:00Z",
	"editions": "ENTERPRISE",
	"consumed": 1,
	"license_model": "Concurrent",
	"license_type": "Functional Test Execution Concurrent Runs",
	"capacity": 2
},{
	"type": "license",
	"id": "1002",
	"license_id": "118102",
	"expiration_date": "2030-12-31T23:59:59Z",
	"start_date": "2024-06-02T00:00:00Z",
	"editions": "ENTERPRISE",
	"consumed": 6,
	"license_model": "Named",
	"license_type": "VSM Quality Named",
	"capacity": 10
},{
	"type": "license",
	"id": "1003",
	"license_id": "120103",
	"expiration_date": "2030-12-31T23:59:59Z",
	"start_date": "2024-06-06T00:00:00Z",
	"editions": "ENTERPRISE",
	"consumed": 16,
	"license_model": "Named",
	"license_type": "ValueEdge Aviator Add-On",
	"capacity": 20
},{
	"type": "license",
	"id": "1004",
	"license_id": "118103",
	"expiration_date": "2030-12-31T23:59:59Z",
	"start_date": "2024-06-02T00:00:00Z",
	"editions": "ENTERPRISE",
	"consumed": 126,
	"license_model": "Concurrent",
	"license_type": "VSM Quality Concurrent",
	"capacity": 200
}]

The consumed attribute means the following:

Concurrent licenses: The amount of licenses currently in use.
Named licenses: The amount of licenses allocated to active users, regardless of whether they are currently logged on.

Peak concurrent license usage

Query the maximum number of licenses in concurrent use by day.

Request

GET .../api/shared_spaces/1001/license_usage?start_date=2024-10-7&end_date=2024-10-11

Response

{
  "license_usage": {
       "2024-10-7:00:00.000+0000": 1,
       "2024-10-8:00:00.000+0000": 2,
       "2024-10-9:00:00.000+0000": 3,
       "2024-10-10:00:00.000+0000": 4,
       "2024-10-11:00:00.000+0000": 4
       }
       "space_id":1001,
       "start_date": "2024-10-7",
       "end_date": "2024-10-13",
}