Skip to main content

Accessing Code Insight Server REST API Documentation

You can create an administration client (tool) that communicates with the Code Insight server using Code Insight public REST APIs to manage and retrieve project information. These APIs use a REST-style interface and JSON. For more information about this REST interface, see the Rest API Guide Swagger documentation available from the Help menu.

Use the following procedure to access the REST API Swagger documentation for Code Insight.

For information about obtaining the JSON Web Token (JWT) required to access the REST interface, see Managing Authorization Tokens.

To view REST API Swagger documentation for Code Insight, do the following:

  1. From any page in Code Insight, click and select Help from the menu. The Documentation menu appears.
  2. Click Rest API Guide. Swagger documentation for the Code Insight REST API is displayed on a tab in your browser.
  3. To navigate the Swagger documentation, click the down arrow next to an API group to expand the group to its list of APIs.
  4. Click the method button (GET, POST, PUT, DELETE) next to a specific API to expand the API details.
  5. (Optional) In the details for the API, click Try it out to issue the API against the current Code Insight server. (You must provide the security token and required parameters and then click Execute.) The Swagger application generates a cURL command, makes the Rest API call, and displays the response in the details for the API.