Developer Help

This section lists available API references for working with ALM.

API References Description
ALM Project Database Reference Provides a reference for the project database tables and fields.
ALM Open Test Architecture API Reference Provides a reference for the ALM COM-based API. You can use the ALM open test architecture to integrate your own configuration management, defect tracking, and home-grown testing tools with an ALM project.
Site Administration COM API Reference Provides a reference for the Site Administration COM-based API. You can use the Site Administration API to enable your application to organize, manage, and maintain ALM users, projects, domains, connections, and site configuration parameters.
Site Administration REST API Reference

Provides a reference for the Site Administration REST API. You can use the Site Administration REST API to access and work with ALM data in Site Administration.

ALM REST API Reference (Core) Provides a reference for the ALM REST-based API resources. This version has wider coverage of ALM functionality. You can use the REST API to access and work with ALM data.
ALM REST API Reference (Deprecated)

Provides a reference for the ALM REST-based API. You can use the REST API to access and work with ALM defects.

We recommend that you no longer use deprecated REST APIs, although they are still supported. Instead, use REST API Reference (Core) to work with ALM data.

ALM Custom Test Type Reference Provides a reference to the classes and interfaces a developer uses to integrate a testing tool with ALM and a guide to development.