Search Licenses Of Tenant
API to search licenses of a tenant
Request
URI
POST
https://eapi.broadcom.com/vcf/license-mgmt/api/v1/tenants/{tenant_id}/licenses/search
COPY
Query Parameters
integer
page_start
Optional
Constraints:
minimum: 1
default: 1
offset of pageStart
integer
page_limit
Optional
Constraints:
minimum: 10
maximum: 200
default: 10
number of results to be fetched
Request Body
LicenseSearchRequest
of type(s)
application/json
Optional
{
"filters": [
{
"key": "STATUS",
"operator": "EQUALS",
"value": "ACTIVE"
}
],
"sorter": {
"operator": "ASC",
"key": "NAME"
}
}
array of
filters
filters
Optional
filters
sorter
Optional
sorter
Responses
200
OK
Returns
LicenseSearchPage
of type(s)
application/json
This response body class contains all of the following:
InlineLicenseSearchPage0 ,
InlineLicenseSearchPage1
{
"next": 11,
"current": 1,
"results": [
{
"id": "479d239e-38f0-4071-9662-9c516ffdedc3",
"name": "VMware Cloud Foundation (cores)",
"quantity": 41000,
"status": "ACTIVE",
"next_expiry_date": "2025-10-19T10:18:32Z",
"product": {
"name": "VMware Cloud Foundation (cores)",
"uom": "CORE",
"uom_display_name": "Cores"
},
"is_default": true,
"subscriptions": [
{
"id": "3da7c8ab-89b0-4c0a-8a87-291d884a248f",
"serial_number": "411001-1",
"end_date": "2035-01-01T07:59:59Z",
"quantity": 50000
}
],
"version": "v19",
"consumption_details": {
"unit": "CORE",
"unit_display_name": "Cores",
"total": 41000,
"used": 0,
"available": 41000
}
}
]
}
400
Bad Request
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
parameter_list
Optional
parameter_list
string
message
Optional
message
string
major_error_code
Optional
major_error_code
string
minor_error_code
Optional
minor_error_code
401
Unauthorized
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
parameter_list
Optional
parameter_list
string
message
Optional
message
string
major_error_code
Optional
major_error_code
string
minor_error_code
Optional
minor_error_code
403
Forbidden
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
parameter_list
Optional
parameter_list
string
message
Optional
message
string
major_error_code
Optional
major_error_code
string
minor_error_code
Optional
minor_error_code
404
Not Found
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
parameter_list
Optional
parameter_list
string
message
Optional
message
string
major_error_code
Optional
major_error_code
string
minor_error_code
Optional
minor_error_code
500
Internal Server Error
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
array of
string
parameter_list
Optional
parameter_list
string
message
Optional
message
string
major_error_code
Optional
major_error_code
string
minor_error_code
Optional
minor_error_code
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/vcf/license-mgmt/api/v1/tenants/{tenant_id}/licenses/search