VCF Business Services console APIs Operations Index

VCF Business Services console APIs Operations Index

All available VCF Business Services console APIs Operations

License Usage
GET
Download VCF Operations License File(s)

Downloads the license file that can be applied on VCF Ops instance, if the licenses is generated.
POST
Consumption Of Licenses

Usage upload API to upload VCF Operations usages. The usage file is a of .gzip format, which contains signed usages.
GET
Status Of Usage Upload

This Api is used to get the status for the usage file that is uploaded based on upload_id.
Licenses
POST
Search Licenses Of Tenant

API to search licenses of a tenant
POST
License Management

This API is used for managing Licenses. Various operations are supported under this as follows:

  • CREATE: Create license for given subscription
  • UPDATE: Update name or quantity of license
  • DELETE: Delete a license
  • ASSOCIATE: Associate license with VCF Ops instance
  • DISSOCIATE: Dissociate license from VCF Ops instance
Oauth Apps
POST
Search Oauth App

Search Oauth Apps in the context of a tenant.
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 API is used to register a VCF Ops instance in disconnected mode. This API takes the VCF Ops registration file and the VCF Ops Name in the request payload
Token Generation
POST
Generate Token API

Generate Access Token using client id and client secret.
Usage Management
Usage Meter Agents Multi Tenant
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 Agents Single Tenant
GET
Get Agents V1

Get all Usage Meter agents.
POST
Post Agent V1

Register a Usage Meter agent.
GET
Get Agent V1

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

Delete a Usage Meter agent.
PATCH
Patch Agent V1

Update the attributes of an agent.
Usage Meter Status Multi Tenant
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 Meter Status Single Tenant
GET
Get Data Uploads V1

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

Get the latest upload information for a single Usage Meter agent.
Usage Reports Multi Tenant
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.
Usage Reports Single Tenant
GET
Get File V1

Download a usage report.
GET
Get All Reports V1

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

Get all reports for a specified Usage Meter agent.
Validate Licenses
POST
Validate Licenses

This API will be used by the provider to validate the shared licenses for its legitimacy and that it belongs to the customer.