Where to Find the CodeScene REST API Documentation?

CodeScene offers a powerful REST API to enable integration with your workflows, automation scripts, and external systems. Whether you’re using CodeScene On-prem or the Cloud version, the REST API allows you to programmatically access analysis results, configure projects, and more.

Where to Access the API Documentation

• CodeScene On-prem

  • URL: http://<your-codescene-host>/api/v2/docs/index.html

  • This Swagger-based interface lists all available endpoints under REST API version v2.

  • Authentication: Use the Authorize button in the top right corner of the interface, and log in with your CodeScene username and password.

  • Make sure your user account has the necessary REST API access rights.

• CodeScene Cloud

  • URL: https://api.codescene.io/v2/docs

  • This documentation interface also uses Swagger and displays all available endpoints and models under REST API version v2.

  • Authentication: Use the Authorize button and enter the following value:

    Bearer <your_token>


    Replace <your_token> with your personal API token. Tokens can be generated from the CodeScene API tokens page.

What the API Documentation Includes

The Swagger UI provides:

• Descriptions of each endpoint (e.g., retrieve analysis results, configure projects)

• Required and optional parameters

• Response formats and example payloads

• HTTP methods used (e.g., GET, POST, PUT, DELETE)

• Authentication requirements

Each API function is fully documented to help you build your integrations quickly and reliably.