JetBrains CodeCanvas 2024.1 Help

HTTP API

CodeCanvas HTTP API lets you programmatically work with CodeCanvas resources like dev environments, templates, users, and so on. For details on performing particular API requests, use the API Playground. To authenticate your requests, create a service account.

API Playground

API Playground is a built-in tool that lets you:

  • Explore the CodeCanvas API endpoints.

  • Create API requests in various formats (cURL, IDEA HTTP, JavaScript).

  • Execute API requests on behalf of a user and see the responses.

API playground

To open API Playground

  1. On the sidebar menu, select Administration.

  2. Select API Playground.

Service accounts

Service accounts are special accounts that are used to access CodeCanvas resources programmatically. If you have a script or an application that interacts with CodeCanvas, use a service account to authenticate your requests on behalf of the application. When creating the account, you specify main application settings: an authorization flow, required permissions, the application's endpoints, and others.

Create a service account

  1. On the sidebar menu, select Administration.

  2. Select API Playground.

  3. Click New service account.

  4. Specify:

    • A unique account Name.

    • An Email address.

  5. Click Create.

  6. Click Go to settings and specify other settings: account permissions, authorization flow, application endpoint, and so on.

Last modified: 17 May 2024