Tenant Licenses Search

Tenant Licenses Search
Search licenses of a tenant

Get the licenses of a tenant based on the provided search criteria.

Request
URI
POST
https://eapi.broadcom.com/vcf/license-mgmt/api/v1/tenants/{tenant_id}/licenses/search
COPY
Path Parameters
string
tenant_id
Required

ID of the tenant

Query Parameters
integer
page_start
Optional
Constraints: minimum: 1 default: 1

Offset of page start. The number of items to skip before starting to collect the result set.

integer
page_limit
Optional
Constraints: minimum: 10 maximum: 200 default: 10

The maximum number of items to return in the response. Use this parameter to limit the size of the result set.

Request Body
LicenseSearchRequest of type(s) application/json
Optional 
{
    "filters": [
        {
            "key": "STATUS",
            "operator": "EQUALS",
            "value": "ACTIVE"
        },
        {
            "key": "VCF_OPS_ID",
            "operator": "LIKE",
            "value": "99979626-5ddf"
        }
    ],
    "sorter": {
        "key": "NAME",
        "operator": "ASC"
    }
}
array of filters
filters
Optional

A list of conditional criteria used to refine and narrow down the search results. Multiple filters are applied using logical 'AND' conditions (i.e., a record must satisfy all provided filters to be returned).

sorter
Optional

Defines the ordering criteria for the result set. Specifies the target property and the direction (ascending or descending) to arrange the returned records.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LicenseSearchPage of type(s) application/json 
{
    "next": 1,
    "current": 1,
    "total_results": 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",
                "product_name": "VMware Cloud Foundation",
                "type": "BASE"
            },
            "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
            }
        }
    ]
}
number
next
Optional

Next page number

number
current
Optional

Current page number

number
total_results
Optional

Total results across all pages

array of results
results
Optional

The item list of the response page


400

Bad Request

Returns ErrorResponse of type(s) application/json 
{
    "message": "Unexpected value 'VCF_OPS'",
    "major_error_code": "400",
    "minor_error_code": "INVALID_REQUEST"
}
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 
{
    "major_error_code": "401",
    "minor_error_code": "UNAUTHORIZED",
    "message": "Authentication failed"
}
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 
{
    "major_error_code": "403",
    "minor_error_code": "ACCESS_DENIED",
    "message": "Access Denied"
}
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 
{
    "message": "Tenant 567905de-ef1c-48ce-9e4e-05c28f5caaa6 not found.",
    "major_error_code": "NOT_FOUND",
    "minor_error_code": "TENANT_NOT_FOUND"
}
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 
{
    "message": "Failed to search licenses.",
    "major_error_code": "LICENSE_ERROR",
    "minor_error_code": "SEARCH_LICENSE_FAILED"
}
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
On This Page
Licenses Operations
POST
Tenant Licenses Search
POST
License Management
POST
Associate Licenses To License Server
POST
Dissociate Licenses From License Server