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 within a Gzip-compressed file.
GET
Status Of Usage Upload

This endpoint facilitates the retrieval of the processing status for a usage file, identified by the provided upload_id.
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
  • ASSOCIATE: Associate license with VCF ops instance
  • DISSOCIATE: Dissociate license from VCF ops instance
GET
Download VCF Operations License File(s)

Downloads the license file that can be applied on VCF Ops instance, if the licenses is generated.
Oauth Apps
POST
Search Oauth App

Search Oauth apps in the context of a tenant based on 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
POST
VCF Operations Disconnected Registration

This endpoint facilitates the registration of a VCF ops instance operating offline(disconnected mode). The request requires a multi-part payload containing the VCF ops name and the necessary registration file.
Token Generation
POST
Generate Token API

Generate Access Token using client id and client secret.
Usage Management
Usage Meter Agents
GET
Get Agents

Get all Usage Meter agents.
POST
Post Agent

Register a Usage Meter agent.
PATCH
Move Agents

Move Usage Meter agents to another tenant.
GET
Get Agent

Get all attributes for a Usage Meter agent.
DELETE
Delete Agent

Delete a Usage Meter agent.
PATCH
Patch Agent

Update the attributes of a Usage Meter agent.
GET
Get Agent Oauth App

Get validated status of OAuth application associated to the specified Usage Meter agent.
POST
Post Agent Oauth App

Create OAuth application for the specified Usage Meter agent.
DELETE
Delete Agent Oauth App

Deletes the oauth app associated with the given agent.
Usage Meter Status
GET
Get Data Uploads

Get the latest upload information for all Usage Meter agents.
GET
Get Data Uploads For UM

Get the latest upload information for a single Usage Meter agent.
Usage Reports
GET
Get File

Download a usage report.
GET
Get All Reports

Get all reports for the tenant calling the API.
GET
Get Reports For Month

Get all reports for a specified Usage Meter agent.
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.