Welcome to the vCenter Chargeback Manager APIs Reference Guide.
This page includes the following information:
This API reference guide presents all the vCenter Chargeback Manager APIs. The guide provides the following information about each API:.
Note: Some resource schemas may appear to contain extra sections that cannot be accessed by any listed API. These sections are marked within the XSD files as private resource types and should remain unused. Usage of these private resource types is not supported.
vCenter Chargeback Manager APIs provide an interface for application developers to programmatically use the vCenter Chargeback Manager functionality. As an application developer, you can use these APIs to programmatically perform the following tasks:
vCenter Chargeback Manager APIs are REST APIs. REST APIs typically help you make requests for resources and receive responses over the network. A request can be one of the following types: PUT, POST, .GET, or DELETE.
Each vCenter Chargeback Manager API has the following syntax:
<HTTP_request_method> <Base_Url>/<API_signature>
Syntax Component |
Description |
---|---|
HTTP_request_method |
Can be one of the following HTTP request types: PUT, POST, GET, or DELETE |
Base_Url |
Is the URL of the vCenter Chargeback Manager host. The Base Url for vCenter Chargeback Manager APIs is: |
API_signature |
The URL path for a vCenter Chargeback Manager API. For example, /hierarchies retrieves the hierarchies added to the vCenter Chargeback Manager running on 123.123.123.123 |
version |
API version. For vCenter Chargeback Manager 2.0, it needs to be passed as 2.0 |
Note: If you want to use vCenter Chargeback 1.5 APIs, you need to do the following:
This release of vCenter Chargeback Manager supports IPv6 over IPv4. You can include IPv6 addresses in the URLs. Ensure that the IPv6 addresses are enclosed in square brackets [ ] as per the standard convention.
This guide provides sample request and response XML files for all the vCenter Chargeback Manager APIs. All these samples are linked from the respective reference pages in this guide. To use the sample files, in the relevant API reference page, click the link to the sample and open the file in an XML Editor.