VMware Cloud Foundation Usage Meter Appliance API Operations Index
All available VMware Cloud Foundation Usage Meter Appliance API Operations
Returns the same usage report with all fields deanonymized.
Returns all anonymization settings available in this usage meter appliance.
Change anonymization settings with the given values. To disable/enable only provided the disabled flag in the request body. To clear the redaction string, provide a null attribute in the request body. When you want to change a anonymization group, only set it in the settings array. The rest of the groups will be intact.
Get the current cloud authentication details.
Update cloud authentication details using the access token from VCF Console.
Get all customer rules or limit the result for a given name only.
This API creates customer rules. It returns the created rules definition by providing its IDs.
Deletes customer rules from the Usage Meter
This API updates customer rules. Only rule name update is allowed. It returns the updated rules definition.
Get a customer rule by its id.
Deletes customer rule from the Usage Meter
This API updates customer rule. Only rule name update is allowed. It returns the updated rule definition.
Get customer rules audit per type.
Get product inventory information based on search criteria.
This API provides information like build number, version and UUID of the Usage Meter appliance.
Get the current tenant details
Update the current tenant details. This is the final step of the initialization wizard flow.
Get the Data Usage text and acceptance state.
Update Data Usage Acceptance.
Testing access token and proxy (if any).
Returns all email notification settings.
Perform the update over the existing mail notification settings.
Apply a collection of patch instructions (updates) against the existing mail notification settings.
Delete currently saved email notification settings.
Retrieves one or more messages that require user action. For example, after adding a new product to the Usage Meter, you can invoke this API to view the product certificate details and obtain the certificateId.
Retrieves notification messages. For example, you can use this API to check if there are errors in the Usage Meter appliance (with a query param level=Err).
This API returns, among other fields, the ID of the newly added product. Please note - This ID must be provided (as productId) for operations like accept certificates, retrieve notification messages or update/delete the product.
Retrieves one or more products from the Usage Meter.
Updates and activates a product. For example, this API can update the password for a vCenter.
Deletes a product from the Usage Meter
Use this API to accept or decline a certificate. 'certificateId' can be obtained from /user_action API response.
Obtain the current proxy's configuration.
Update the current proxy's configuration. This is part of the initialization wizard. Upon successful test_proxy with accessToken and proxy details, invoke this endpoint to save the proxy settings. In case no proxy is involved (direct connection to cloud) invoking this method is not required.
Gets security settings currently configured for usage meter.
Update security settings in usage meter
This API creates a login session. It returns the bearer token that must be used as a Authorization header parameter for all subsequent Usage Meter operations.
Provides a list of at most 12 reporting periods (most recent first) for which the usage data is available
Downloads usage data in an opaque binary format suitable only for subsequent upload to VMware. Most customers will have no need to use this API.