This page last changed on Aug 31, 2009 by mmcgarry.

HQ API

The HQ API is HQ's built-in web services API; it enables programmatic and command line access to HQ Server features and data. In Hyperic HQ 4.0, the HQ API replaced the Command Line Interface (CLI) available in previous versions of HQ.

To download the API, click HQ Web Services Api in the "Plugins" section of the Administration page. The API package includes:

  • The hqapi-n.n.jar client library and support jars.
  • The XSD that defines the web service.
  • Javadoc documentation for the API.

The HQ API supports two methods of interaction:

  • Programmatic access through the Java API.
  • Script-based access using command line tools.

For API documentation, see HQ Web Services API.

The SVN repository has Test code.

Document generated by Confluence on Apr 20, 2010 15:01