License Management

License Management
API for managing licenses.

This API is used for managing Licenses. Various operations listed below are supported by this API:

  • CREATE: Create a license for given subscription
  • UPDATE: Update name or quantity of a license
  • DELETE: Delete a license
  • ASSOCIATE: Associate license with VCF ops instance
  • DISSOCIATE: Dissociate license from VCF ops instance
Request
URI
POST
https://eapi.broadcom.com/vcf/license-mgmt/api/v1/tenants/{tenant_id}/licenses
COPY
Path Parameters
string
tenant_id
Required

The id of the tenant

Request Body
LicenseOperationRequest of type(s) application/json
Required

Show optional properties

{
    "operation": "CREATE"
}
{
    "operation": "CREATE",
    "license_create_request": [
        {
            "serial_number": "b315e640-f4c5-4f42-a8f9-450312eae2f9",
            "name": "Name",
            "quantity": 70
        }
    ]
}
string
operation
Required

The operation to perform for a license, options are:

  • CREATE: Create license for given subscription
  • UPDATE: Update name or quantity of a license
  • DELETE: Delete a license
  • ASSOCIATE: Associate license with VCF ops instance
  • DISSOCIATE: Dissociate license from VCF ops instance
Possible values are : CREATE, UPDATE, DELETE, ASSOCIATE, DISSOCIATE,
array of object
license_create_request
Optional

Request json to create a new license.

array of object
license_update_request
Optional

Request json to update a license.

object
license_delete_request
Optional

Request json to delete one or more licenses

object
license_associate_request
Optional

Request json to associate or disassociate a license with vcf ops instance.

object
license_dissociate_request
Optional

Request json to associate or disassociate a license with vcf ops instance.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns LicenseOperationResponse of type(s) application/json 
{
    "operation": "CREATE",
    "license_create_response": [
        {
            "id": "b315e640-f4c5-4f42-a8f9-450312eae2f9",
            "name": "Share license - VMware Cloud Foundation (cores) - 6",
            "quantity": 900,
            "status": "ACTIVE",
            "next_expiry_date": "2025-10-19T10:46:58Z",
            "version": "v2",
            "product": {
                "name": "VMware Cloud Foundation (cores)",
                "uom": "CORE",
                "uom_display_name": "Cores"
            },
            "is_default": false,
            "subscriptions": [
                {
                    "id": "3da7c8ab-89b0-4c0a-8a87-291d884a248f",
                    "serial_number": "411001-1",
                    "end_date": "2035-01-01T07:59:59Z",
                    "quantity": 50000
                }
            ]
        }
    ]
}
string
operation
Required

The operation to perform for a license, options are:

  • CREATE: Create license for given subscription
  • UPDATE: Update name or quantity of a license
  • DELETE: Delete a license
  • ASSOCIATE: Associate license with VCF ops instance
  • DISSOCIATE: Dissociate license from VCF ops instance
Possible values are : CREATE, UPDATE, DELETE, ASSOCIATE, DISSOCIATE,
array of object
license_create_response
Optional

license_create_response

array of license_update_response
license_update_response
Optional

license_update_response

object
license_delete_response
Optional

Response of the delete license operation.

license_associate_response
Optional

license_associate_response

license_dissociate_response
Optional

license_dissociate_response


400

Bad Request

Returns ErrorResponse of type(s) application/json 
{
    "parameter_list": [
        "string"
    ],
    "message": "string",
    "major_error_code": "string",
    "minor_error_code": "string"
}
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 '{"operation:"string"}' https://{api_host}/vcf/license-mgmt/api/v1/tenants/{tenant_id}/licenses
On This Page
Licenses Operations
POST
Tenant Licenses Search
POST
License Management
GET
Download VCF Operations License File(s)