Helix ALM REST API Documentation

Submit Search

The Helix ALM REST API lets developers extend Helix ALM to automate tasks and develop applications that integrate with Helix ALM. When a request is submitted from an application, it is sent to the API, which interprets the request, retrieves the information from the Helix ALM Server, and sends a response in JSON.

Getting started

Learn everything you need to know to get started with the REST API, including installation and configuration, and how to connect to the API.

Reference and examples

For detailed information about REST API resources and response objects with examples, see the interactive help for the current version. You can also view help locally for the version you are using.

Authentication

Learn everything you need to know to get started with the REST API, including installation and configuration, and how to connect to the API.

Error and response codes

Learn about the status codes and messages the REST API returns in the header, and JSON objects it returns in the response body.

Additional help

Need more help? Browse and search all Helix ALM documentation to find what you need.

Perforce and other identified trademarks are the property of Perforce Software, Inc., or one of its affiliates. Such trademarks are claimed and/or registered in the U.S. and other countries and regions. All third-party trademarks are the property of their respective holders. References to third-party trademarks do not imply endorsement or sponsorship of any products or services by the trademark holder. Contact Perforce Software, Inc., for further details.