Consumption Of Licenses

Consumption Of Licenses
Usage upload

Facilitates the upload of VCF operations usage data. The request body must contain the signed usage records within a Gzip-compressed file.

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

The id of the tenant

Request Body

The API accepts a Gzip-compressed JWS file containing the list of usages.

UsageForLicenseRequest of type(s) multipart/form-data
Required 
{
    "file": "usages_10_nov.jws.gzip"
}
string As binary As binary
file
Required

Gzip-compressed usages file.

Authentication
This operation uses the following authentication methods.
Responses
200

Usage is uploaded/accepted, processing of data is yet to happen.

Returns UsageForLicenseUploadResponse of type(s) application/json 
{
    "upload_id": "30a34d62-2136-4bc8-aaaa-c98df4428634",
    "upload_status": "SUCCESS",
    "uploaded_on": "2024-07-01T01:00:00Z"
}
string
upload_id
Required

upload_id

string
upload_status
Required

The status of the operation.

  • UPLOADING: The usage file is getting uploaded to VCF BSC portal.
  • SUCCESS: The usage file is uploaded successfully the usage processing is yet to start.
  • FAILED: The usage file upload has failed.
Possible values are : UPLOADING, SUCCESS, FAILED,
string
uploaded_on
Required

uploaded_on


400

Bad request

Returns ErrorResponse of type(s) application/json 
{
    "major_error_code": "USAGE_UPLOAD_FAILED",
    "minor_error_code": "FILE_TYPE_NOT_SUPPORTED",
    "error_message": "Only gzip file is supported."
}
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": "USAGE_UPLOAD_FAILED",
    "minor_error_code": "NOT_AUTHORIZED",
    "message": "User is not authorized into the system."
}
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 Request

Returns ErrorResponse of type(s) application/json 
{
    "major_error_code": "USAGE_UPLOAD_FAILED",
    "minor_error_code": "NO_SUFFICIENT_PRIVILEGES",
    "message": "User doesn't have enough privileges to upload."
}
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


409

Duplicate file uploaded

Returns ErrorResponse of type(s) application/json 
{
    "major_error_code": "USAGE_UPLOAD_FAILED",
    "minor_error_code": "DUPLICATE_FILE_UPLOADED",
    "message": "Duplicate file uploaded."
}
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 .In case upload has failed

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: multipart/form-data' -d '{"file:"string"}' https://{api_host}/vcf/license-usage/api/v1/tenants/{tenant_id}/license-usage/upload
On This Page
License Usage Operations
POST
Consumption Of Licenses
GET
Status Of Usage Upload