The REST API endpoints in DTP provide programmatic access to build, static analysis, coverage, and other data hosted in DTP. The REST APIs can be used by developers who want to integrate DTP with other applications.

In this section:

Authentication

DTP REST API is only available over SSL (HTTPS). If you upgraded from a version prior to 4.9.3, you need to manually enable the SSL port. See Enabling SSL for instructions.

By default, the API uses basic authentication, which can be passed to the API using the Authorization HTTP header in the following format:

Authorization: Basic <USERNAME>:<PASSWORD> 

The username and password must be in Base64 encoding. The username/password required are the same username/password required to log into DTP.

Basic authentication is not supported if you are running DTP in OpenID Connect mode. Instead, authorization token from the OpenID Connect provider must be passed int he HTTP header. See Configuring OpenID Connect for details.

Accessing the API Documentation

1. Choose API Documentation from the Help menu to access the API documentation from the GUI:
   

   

   Info
   title Accessing the API from the Browser
   The API can also be accessed by entering https://<HOST>:<PORT>/grs/api into the browser address bar. Typically, the URL is https://<HOST>/grs/api if DTP is deployed on port 80. If DTP is deployed on another port, the https port is typically 8443.

2. Click on a resource to access its parameters.
   
   

3. Click More Information in a resource section to view its complete documentation.