Site Administration REST API Reference

You can use the Site Administration REST API to access and work with ALM data in Site Administration. The ALM Site Administration REST API reference provides a complete online reference for the Site Administration REST-based API.

In this topic:

Access SA REST API documentation

The Site Administration REST API documentation is embedded in the product.

To access the Site Administration REST API documentation:

1. From the ALM qcbin page (http://<ALM server>:<port number>/qcbin/), click the Tools link.

2. At the bottom of the ALM Tools page, click the ALM Site Administration REST API Guidance link.

   This documentation includes all REST APIs with the URL starting with qcbin/v2/sa/api.

Back to top

SaaS only APIs

The APIs that have the SaaS only tag are available for ALM SaaS only. You cannot use them for on-premises environments.

For on-premises, all the APIs without this tag are available for use.

Back to top

Permissions

Available in versions: 17.0.1 and later

The Permissions section is available for each Site Administration REST API, listing the minimum permissions required to use an API.

We recommend you read the Permissions section before calling an API.

Back to top