VCF Business Services console APIs Operations Index

VCF Business Services console APIs Operations Index

All available VCF Business Services console APIs Operations

License Usage
POST
Consumption Of Licenses

Facilitates the upload of VCF Operations usage data. The request body must contain the signed usage records in a Gzip-compressed file. Use the 'upload_id' in the response to check the Status Of Usage Upload.

GET
Status Of Usage Upload

This endpoint facilitates the retrieval of the processing status for a usage file, identified by the provided upload_id in the Consumption Of Licenses response.

Licenses
POST
Tenant Licenses Search

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

POST
License Management

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

  • SPLIT: Create a split license from a given default license (allowed only for Direct Customer)
  • CREATE: Create license for given subscription (allowed only for Provider)
  • UPDATE: Update name or quantity of a license
  • DELETE: Delete a license
POST
Associate Licenses To License Server

Associate licenses with a license server. Assigns the specified licenses to a specific license server within a VCF Operations instance for the given tenant.

POST
Dissociate Licenses From License Server

Dissociate licenses from a license server.Removes the association between the specified licenses and the designated license server within a VCF Operations instance for the given tenant.

Oauth Apps
POST
Search Oauth App

Search Oauth apps associated with a tenant based on the provided search criteria.

POST
Revoke Client

Revoke Oauth App Client. You need to pass asset id or client id as input. Asset id/client id can be fetched from Oauth App search api.

POST
Regenerate Client

Regenerate Oauth client secret. This apis revokes current client and creates new client id and secret. Either asset id or client id should be passed as input. Asset id/client id can be fetched from Oauth App search api.

Registration And Vcf Operations
GET
Download VCF Operations License File(s)

Downloads the VCF Operations license file.The recommended filename for the downloaded file is provided in the Content-Disposition response header.

POST
VCF Operations Registration

This endpoint facilitates the registration of a VCF Operations (version 9.1 & above) instance operating offline(disconnected mode). The request requires a registration file containing the VCF Operations, license servers and the required details. API response returns VCF Operations registration status. VCF Operations version upgrade from 9.0 is not supported by the API.

GET
Download License Server Verification File


Downloads a verification file containing requests for all license servers associated with the specified VCF Operations instance. This file is required for license server activation and must be uploaded to VCF Operations to validate the servers. The recommended filename for the downloaded file is provided in the Content-Disposition response header.
POST
Upload License Server Confirmation File


To complete the license server registration, upload the confirmation file from your VCF Operations instance to the VCF Business Services console. The API returns the confirmation status for each license server.
GET
Get License Server Details By Id

Get license server by ID. Returns the details of a license server using its unique id associated to a specific tenant and a VCF Operations instance.

POST
Deactivate License Server

This API deactivates the license server. Please ensure that no active licenses are associated with the server before proceeding. Request body is not required.

Token Generation
POST
Generate Token API

Generate Access Token using client id and client secret.

Usage Management
Validate Licenses
POST
Validate Licenses

This API allows the provider to authenticate and confirm the validity of shared licenses, ensuring they are legitimate and correctly entitled to the specified customer.