Extending product function
Learn how to extend the product.
- HCL Compass REST API developer guide
  - Getting started with the HCL Compass REST API
    The HCL Compass REST API allows developers to interact with HCL Compass by using HTTP based REST APIs.
  - Creating the HCL Compass REST API SSL Certificate
    HCL Compass uses SSL to secure access to its user interface and REST APIs. A self signed certificate is provided out of the box, but some proxies and gateways will accept self-signed certificates.
  - Installing SSL certificates
    You can install SSL certificates into HCL Compass, the HCL Compass Docker container, or into the HCL Compass Helm Chart.
  - Authenticating to the HCL Compass REST API
    Before making an API call, you must authenticate with the REST API server and use POST to obtain an authorization token.
  - Keycloak integration
    Keycloak provides open source identity and access management and can be integrated with HCL Compass to help you manage your HCL Compass users.
  - Repositories and databases
    You can use the HCL Compass REST API to interact with repositories and databases.
  - Records and record types
    A Record Type describes the structure (meta4tdata) of a Record and is designed by the HCL Compass Designer.
  - Creating, Deleting, and Retrieving Records
    You can use the HCL Compass REST API to Create, Delete, and Retrieve records.
  - HCL Compass REST API queries and result sets
    You can use the HCL Compass REST API to manage queries and result sets.
  - HCL Compass REST API troubleshooting
    Troubleshooting for various restrictions and known issues when using the HCL Compass REST API.
  - Webhooks integration package
    Webhooks serve as a communication mechanism between systems. A webhook subscribes to HCL Compass and waits. When events are triggered, HCL Compass sends information out to the subscriber.
  - GitIntegration package
    The GitIntegration package allows the Compass REST API server to act on GitHub payloads. This allows GitHub events to be connected to records in Compass as they happen.
- Programming with the HCL Compass OSLC CM REST API
  Learn how to use Compass CM REST API that supports both, OSLC v1 and v2.
- Programming with HCL Compass CM API

HCL Compass REST API developer guide

Note: Use of the REST API server is not supported in an on premises environment, such as on Windows and Linux. To use the HCL Compass REST API server in a supported environment, deploy the HCL Compass REST API server to a Kubernetes environment. For more information, see Getting Started with HCL Compass Helm Chart.