REST API

The Helix ALM REST API has several endpoints that developers can use for interfacing with their organization’s Helix ALM instance. The wide variety of endpoints provide many possibilities for developers to create tools or scripts to aid in their organization’s workflow, with few limitations.

The REST API is available at:

				
					https://{organization}:{port}/helix-alm/api/v0/

and the Swagger UI interactive documentation tool is available at:

				
					https://{organization}:{port}

where {organization} is the address of the REST API server.
The address can be configured in the JSON configuration file of the REST API, typically located at:

				
					../Perforce/Helix ALM/helix-alm-rest-api/config/config.json

on the server that is running the Helix ALM instance.

To learn more or get help from our experts, contact us at your earliest convenience. We’re excited to see what you will build!

The Jama Connect REST API empowers your team to build custom integrations and tools that enhance productivity. With the ability to programmatically create and manage items, projects, and configurations in Jama Connect, you can optimize your product development lifecycle.

Here are some key benefits of leveraging the REST API:

Automate repetitive tasks

Use the API to create projects and items in bulk based on predefined templates. Simplify administration and standardize processes.

Extend Jama Connect

Build complementary apps and plugins tailored to your team’s specific needs. Seamlessly exchange data between Jama Connect and other systems.

Boost efficiency

Script common workflows to move fast without sacrificing quality. Focus your energy where it matters most.

Enable innovation

With an extensive set of API endpoints, the only limit is your creativity. Adapt Jama Connect to perfectly fit your product development methodology.

Getting started with the REST API is easy

Authenticate using your Jama Connect credentials or OAuth
Explore the interactive API documentation
Make your first API call to create a project or item
Iterate and refine your integration to unlock maximum value