IDE Services

https://www.jetbrains.com/help/ide-services/
Admin
IDE Services is a developer experience suite from JetBrains that unlocks productivity at an...
Tokens:96,206
Snippets:646
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Describe Kubernetes Pod

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Provides detailed information about a specific Kubernetes pod, including its status, events, and configuration. Replace ${POD_NAME} with the actual name of the pod you are investigating.

```bash
kubectl -n kube-ide-services describe po "${POD_NAME}"
```

--------------------------------

### Deploy Docker Compose Configuration

Source: https://www.jetbrains.com/help/ide-services/try-demo

Deploys the Docker Compose configuration to start the IDE Services Demo. Requires Docker and Docker Compose to be installed and running.

```bash
docker-compose up
```

--------------------------------

### Helm Chart Repository Addition

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Adds the JetBrains IDE Services Helm chart repository to your Helm configuration. This command allows Helm to fetch the necessary chart files for installation.

```bash
helm repo add jetbrains-ide-services \
https://download.jetbrains.com/ide-services/charts/stable
```

--------------------------------

### Start IDE Services Server using Binaries (Windows)

Source: https://www.jetbrains.com/help/ide-services/docker-installation

Executes the IDE Services Server using its Windows batch launcher. Requires Java 17+, a configured application.yaml, and the SPRING_CONFIG_ADDITIONAL_LOCATION environment variable set.

```Batch
set SPRING_CONFIG_ADDITIONAL_LOCATION=`pwd`/application.yaml
/tbe-launcher-2025.4.2.2185/bin/tbe-launcher.bat
```

--------------------------------

### Code With Me Guest Setup File Locations (macOS, Windows, Linux)

Source: https://www.jetbrains.com/help/ide-services/-cloud/getting-started-with-codewithme-for-business

This snippet outlines the default directory paths for Code With Me logs, caches, and settings across different operating systems. These paths are crucial for troubleshooting and managing the guest IDE installation.

```text
macOS
Windows
Linux
~/Library/Logs/JetBrains/JetBrainsClient<plugin_version>
%LOCALAPPDATA%\JetBrains\JetBrainsClient<plugin_version>\log
~/.cache/JetBrains/JetBrainsClient<plugin_version>/log

~/Library/Caches/JetBrains/JetBrainsClient<plugin_version>
%LOCALAPPDATA%\JetBrains\JetBrainsClient<plugin_version>
~/.cache/JetBrains/JetBrainsClient<plugin_version>

~/Library/Application\ Support/JetBrains/JetBrainsClient<plugin_version>
%APPDATA%\Roaming\JetBrains\JetBrainsClient<plugin_version>
~/.config/JetBrains/JetBrainsClient<plugin_version>
```

--------------------------------

### DNS TXT Record Example

Source: https://www.jetbrains.com/help/ide-services/-cloud/Automatic_server_discovery

Example of a DNS TXT record configuration for JetBrains IDE Services URL.

```text
_jetbrains-license-server.company.com

with this text:

url=https://my-company.jetbrains-ide-services.com
```

--------------------------------

### Plugin Download Log Example (JSON)

Source: https://www.jetbrains.com/help/ide-services/advanced-configuration

This JSON snippet represents a log entry for a plugin download request. It includes timestamp, level, logger details, the message indicating the requested plugin ID and version, and MDC context.

```json
{
    "@timestamp" : "2024-11-04T09:08:24.982065Z",
    "level" : "INFO",
    "logger" : "com.jetbrains.tbe.server.sys.BinaryAccessLogger",
    "thread" : "reactor-tcp-nio-2",
    "message" : "Requested downloading plugin with id: com.intellij.mockcss, version: 123, resolved to: localhost",
    "mdc" : {
        "auditId" : "eda396b7-407b-40ae-93c8-2a53a3cf257c:f12e3b3d-1234-4bc8-b234-5678e9abcdef:john.smith",
        "userId" : "eda396b7-407b-40ae-93c8-2a53a3cf257c",
        "requestId" : "6c3a0ba3-c5f2-48ee-b6ff-ee7859ed5cd1"
    }
}
```

--------------------------------

### Deploy IDE Services Helm Chart

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Upgrades or installs the IDE Services Helm chart with specified release name and custom configuration from `values.yaml`. This command deploys the services to the Kubernetes cluster.

```shell
helm upgrade -i  <desired_release_name> -f ./values.yaml
```

--------------------------------

### Retrieve Kubernetes Events

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Fetches recent events from the Kubernetes cluster within a specific namespace. This command is useful for troubleshooting pod startup failures or other cluster-level issues.

```bash
kubectl -n kube-ide-services get event
```

--------------------------------

### Generate Certificates for Code With Me Relay Authentication

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Generates private and public keys using OpenSSL for authenticating users on Code With Me Relays. These keys are crucial for secure communication within the Code With Me Enterprise setup.

```shell
openssl ecparam -name secp384r1 -genkey -noout -out relay_auth_private.pem
openssl ec -in relay_auth_private.pem -pubout -out relay_auth_public.pem
```

--------------------------------

### Start IDE Services Server using Binaries (Linux/macOS)

Source: https://www.jetbrains.com/help/ide-services/docker-installation

Executes the IDE Services Server using its binary launcher on Linux or macOS. Requires Java 17+, a configured application.yaml, and the SPRING_CONFIG_ADDITIONAL_LOCATION environment variable set.

```Shell
export SPRING_CONFIG_ADDITIONAL_LOCATION=`pwd`/application.yaml
/tbe-launcher-2025.4.2.2185/bin/tbe-launcher
```

--------------------------------

### IDE Download Log Example (JSON)

Source: https://www.jetbrains.com/help/ide-services/advanced-configuration

This JSON snippet represents a log entry for an IDE download request. It includes timestamp, level, logger details, the message indicating the requested IDE and version, and MDC context with auditId, userId, and requestId.

```json
{
    "@timestamp" : "2024-11-04T09:03:08.656933Z",
    "level" : "INFO",
    "logger" : "com.jetbrains.tbe.server.sys.BinaryAccessLogger",
    "thread" : "reactor-http-nio-15",
    "message" : "Requested downloading for IDE: DataGrip, version: 2021.2, build: 212.4746.86",
    "mdc" : {
        "auditId" : "6d3a606c-d28a-42df-b47f-04ee210e4ba0:f12e3b3d-1234-4bc8-b234-5678e9abcdef:john.smith",
        "userId" : "6d3a606c-d28a-42df-b47f-04ee210e4ba0",
        "requestId" : "3e0c668e-35a3-424e-bb31-b361bf820a7c"
    }
}
```

--------------------------------

### OCI Image Deployment

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Deploys the JetBrains IDE Services Helm chart directly from an OCI registry. Similar to the Helm chart deployment, it uses a specific version and a custom values.yaml file.

```bash
helm install jb-ide-services \
oci://registry-1.docker.io/jetbrains/ide-services-helm \
--version 2025.4.2 \
--namespace kube-ide-services \
-f values.yaml
```

--------------------------------

### Configure Code With Me Relay in values.yaml

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Defines the configuration for the Code With Me Relay within the `values.yaml` file. This includes enabling the relay, configuring ingress host patterns, and embedding JWT public and private keys for authentication.

```yaml
cwmrelay:
  enabled: true
  ingress:
    enabled: true
    hostPattern: "cwm-__REPLICA_ID__.lvh.me" #mandatory
    <your_ingress_configuration>
  config:
    jwtPublicKey: |
    -----BEGIN PUBLIC KEY-----
    Your relay_auth_public.pem goes here
    -----END PUBLIC KEY-----
    jwtPrivateKey: |
    -----BEGIN EC PRIVATE KEY-----
    Your relay_auth_private.pem goes here
    -----END EC PRIVATE KEY-----
```

--------------------------------

### Windows Toolbox Installer (GET)

Source: https://www.jetbrains.com/help/ide-services/whats-new

Endpoint for retrieving information related to the Windows toolbox installer.

```HTTP
GET /api/toolbox/installer/windows
```

--------------------------------

### Verify IDE Services Pods

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Checks the status of pods within the specified Kubernetes namespace for IDE Services. It lists all pods and their current states, helping to diagnose any running issues.

```bash
kubectl -n kube-ide-services get pods
```

--------------------------------

### Run IDE Services Server in Docker (Windows)

Source: https://www.jetbrains.com/help/ide-services/docker-installation

Starts the IDE Services Server within a Docker container on Windows. It uses '^' for line continuation, mounts the local application.yaml for configuration, and maps port 8080 to port 80 on the host machine. Requires Docker and a pre-configured application.yaml.

```Shell
docker run -it ^
-v `pwd`/application.yaml:/config/application.yaml ^
-e SPRING_CONFIG_ADDITIONAL-LOCATION=/config/application.yaml ^
-p 80:8080 ^
docker.io/jetbrains/ide-services:2025.4.2.2185
```

--------------------------------

### JetBrains Client Installation Paths via IDE Services (macOS, Windows, Linux)

Source: https://www.jetbrains.com/help/ide-services/-cloud/getting-started-with-codewithme-for-business

This snippet specifies the installation directory paths for JetBrains Client when the Code With Me session is initiated through IDE Services, applicable for macOS, Windows, and Linux environments.

```text
macOS
Windows
Linux
~/Library/Application Support/JetBrains/Toolbox/internal-tools/JetBrains Client
%LOCALAPPDATA%\JetBrains\Toolbox\internal-tools\JetBrains Client
~/.local/share/JetBrains/Toolbox/internal-tools/JetBrains Client
```

--------------------------------

### GET /api/toolbox/installer/windows

Source: https://www.jetbrains.com/help/ide-services/whats-new

Retrieves information for the Windows toolbox installer.

```APIDOC
## GET /api/toolbox/installer/windows

### Description
Retrieves information for the Windows toolbox installer.

### Method
GET

### Endpoint
/api/toolbox/installer/windows
```

--------------------------------

### Add 'build' parameter to GET /api/toolbox/installer/windows

Source: https://www.jetbrains.com/help/ide-services/2025-2

A new required query parameter 'build' has been added to the GET /api/toolbox/installer/windows endpoint. This allows specifying the build for the Windows installer.

```HTTP
GET /api/toolbox/installer/windows?build=<build_version>

```

--------------------------------

### DNS TXT Record Example

Source: https://www.jetbrains.com/help/ide-services/Automatic_server_discovery

An example of a DNS TXT record configuration. It shows the record name and the text content which specifies the IDE Services URL.

```dns
_jetbrains-license-server.company.com

with this text:
url=https://ide-services.company.com:8080
```

--------------------------------

### Install Plugins via jetbrains:// Links

Source: https://www.jetbrains.com/help/ide-services/whats-new

Enables the installation of plugins directly using `jetbrains://` URI links. This functionality simplifies the plugin installation process for users.

```text
jetbrains://plugin/install?pluginId=plugin-id-here
```

--------------------------------

### Run IDE Services Server in Docker (Linux/macOS)

Source: https://www.jetbrains.com/help/ide-services/docker-installation

Starts the IDE Services Server within a Docker container. It mounts the local application.yaml for configuration and maps port 8080 to port 80 on the host machine. Requires Docker and a pre-configured application.yaml.

```Shell
docker run -it \
-v `pwd`/application.yaml:/config/application.yaml \
-e SPRING_CONFIG_ADDITIONAL-LOCATION=/config/application.yaml \
-p 80:8080 \
docker.io/jetbrains/ide-services:2025.4.2.2185
```

--------------------------------

### GET /api/toolbox/installer/windows

Source: https://www.jetbrains.com/help/ide-services/-cloud/2025-2

Retrieves the Windows toolbox installer. Adds a new required query parameter 'build'.

```APIDOC
## GET /api/toolbox/installer/windows

### Description
Retrieves the Windows toolbox installer information.

### Method
GET

### Endpoint
`/api/toolbox/installer/windows`

### Parameters
#### Query Parameters
- **build** (string) - Required - The build version of the installer.

```

--------------------------------

### LDAP Server Connection Examples

Source: https://www.jetbrains.com/help/ide-services/-cloud/ldap-authentication-module

Examples of server addresses for connecting to an LDAP directory service, including standard LDAP and LDAPS over SSL.

```text
ldap://your_ldap_server.com:389
```

```text
ldaps://your_ldap_server.com:636
```

--------------------------------

### Add Build Parameter to Installer API

Source: https://www.jetbrains.com/help/ide-services/-cloud/2025-2

This entry details the addition of the 'build' query parameter to the GET /api/toolbox/installer/windows endpoint, used for specifying the build.

```http
GET /api/toolbox/installer/windows
  * Added the new required 'query' request parameter 'build'
```

--------------------------------

### Get values.yaml for Code With Me Relay (Helm)

Source: https://www.jetbrains.com/help/ide-services/values-file

Retrieves the default `values.yaml` file for Code With Me Relay Helm installation using the Helm CLI. This file contains configuration options for deploying the relay service.

```shell
helm show values oci://docker.io/jetbrains/code-with-me-relay-helm > values.yaml
```

--------------------------------

### Generate IDE Services Helm Chart Template for Offline Deployment

Source: https://www.jetbrains.com/help/ide-services/install-instance-in-kubernetes-cluster

Uses `helm template` to generate a Kubernetes manifest file (`out.yaml`) from the IDE Services Helm chart and a custom `values.yaml`. This is a preparatory step for offline deployment, allowing inspection of resources before actual deployment.

```shell
helm template .  -f ./values.yaml  > out.yaml
```

--------------------------------

### Get values.yaml for IDE Services (Helm)

Source: https://www.jetbrains.com/help/ide-services/values-file

Retrieves the default `values.yaml` file for IDE Services Helm installation using the Helm CLI. This file contains configuration options for deploying IDE Services.

```shell
helm show values oci://docker.io/jetbrains/ide-services-helm > values.yaml
```

--------------------------------

### Set JVM Options for IDE Services Server

Source: https://www.jetbrains.com/help/ide-services/advanced-configuration

This example shows how to pass JVM options to the IDE Services Server using the JAVA_TOOL_OPTIONS environment variable. This is useful for configuring specific Java runtime behaviors.

```bash
JAVA_TOOL_OPTIONS=" -Dtest.property=42 -ea "
```

--------------------------------

### IDE Services Helm Installation

Source: https://www.jetbrains.com/help/ide-services/values-file

Instructions for retrieving the values.yaml file for IDE Services.

```APIDOC
## Get values.yaml for IDE Services

### Description
Retrieves the default values.yaml file for IDE Services using Helm.

### Method
Command Line

### Command
```bash
helm show values oci://docker.io/jetbrains/ide-services-helm > values.yaml
```
```

--------------------------------

### OAuth 2.0 Configuration Guide

Source: https://www.jetbrains.com/help/ide-services/oauth-2-0-configuration

This section provides a comprehensive guide on setting up OAuth 2.0 for IDE Services integration. It outlines the steps required on the authentication provider's side and the essential information needed for IDE Services Server configuration.

```APIDOC
## OAuth 2.0 Configuration for IDE Services

This guide outlines the steps for integrating IDE Services with a third-party authentication provider using OAuth 2.0.

### Setup on Authentication Provider's Side

Configure the following settings within your authentication provider's system:

*   **Redirect URI / Callback URI**
    *   **Description**: The endpoint to redirect the user to after successful authentication.
    *   **Example**: `https://<ide_services_server_domain.com>/api/login/authenticated`
    *   **Note**: Replace `<ide_services_server_domain.com>` with your organization's public server URL. This must match the deployment URL in your server configuration file.

*   **Grant type**
    *   **Description**: Specifies the method for obtaining access tokens. Use `Authorization code` if applicable.

*   **Token endpoint authentication method**
    *   **Description**: Defines how credentials are included in requests to the token endpoint. `client_post` is a common example.

### Information to Save for IDE Services Server Configuration

After configuring your authentication provider, save the following details:

*   **Client ID**: Unique identifier for your IDE Services client.
*   **Client secret**: Secret key for your IDE Services client. This may need to be created manually in some systems.
*   **Login URL**: The URL for initiating the login process. Obtain this from the provider's Well-known configuration.
*   **Token URL**: The URL for exchanging authorization codes for access tokens. Obtain this from the provider's Well-known configuration.
*   **JWT certs URL**: The URL for retrieving JSON Web Token certificates. Obtain this from the provider's Well-known configuration.

### Provider-Specific Instructions

**Note**: Some authentication providers may require additional configurations. Always refer to the provider-specific documentation for detailed guidance.
```

--------------------------------

### Prometheus Metrics Example for IDE Services

Source: https://www.jetbrains.com/help/ide-services/metrics

This snippet shows an example of the output from the /api/metrics endpoint, which exposes infrastructure monitoring data. It includes metric names and descriptions, commonly used for system observability.

```text
# HELP logback_events_total Number of log events that were enabled by the effective log level
 {...}

```

--------------------------------

### Code With Me Relay Helm Installation

Source: https://www.jetbrains.com/help/ide-services/values-file

Instructions for retrieving the values.yaml file for Code With Me Relay.

```APIDOC
## Get values.yaml for Code With Me Relay

### Description
Retrieves the default values.yaml file for Code With Me Relay using Helm.

### Method
Command Line

### Command
```bash
helm show values oci://docker.io/jetbrains/code-with-me-relay-helm > values.yaml
```
```

--------------------------------

### IDE Services OAuth 2.0 Token Endpoint Authentication Example

Source: https://www.jetbrains.com/help/ide-services/oauth-2-0-configuration

Defines the method for including credentials in requests to the token endpoint during OAuth 2.0 authentication. 'client_post' is a common example.

```text
client_post
```

--------------------------------

### LDAP Search Base Example

Source: https://www.jetbrains.com/help/ide-services/-cloud/ldap-authentication-module

An example of a search base DN for an LDAP authentication module, based on a company's domain.

```text
dc=mycompany,dc=com
```

--------------------------------

### Test Keycloak Connection

Source: https://www.jetbrains.com/help/ide-services/-cloud/keycloak-auth-module

Verifies the correct setup of the Keycloak authentication module by initiating a test login.

```APIDOC
## POST /api/hub/settings/auth/keycloak/test-login

### Description
Tests the connection of the Keycloak authentication module to ensure it is set up correctly.

### Method
POST

### Endpoint
/api/hub/settings/auth/keycloak/test-login

### Parameters
No parameters required.

### Request Example
```json
{}```

### Response
#### Success Response (200)
- **status** (string) - Indicates successful login process.

#### Response Example
```json
{
  "status": "Login test successful."
}
```

#### Error Response (400 or other)
- **error** (string) - Provides details about the connection problem.
```

--------------------------------

### Configure authentication details in values.yaml (Helm)

Source: https://www.jetbrains.com/help/ide-services/oauth-2-0-configuration

This snippet demonstrates how to configure authentication provider details within a `values.yaml` file for Helm installations. It covers the same authentication parameters as the `application.yaml` example, including URLs, client credentials, scopes, and admin email lists.

```yaml
ides:
  config:
    auth:
      login-url: "https://<provider-domain>/oauth2/authorize"
      token-url: "https://<provider-domain>/oauth2/token"
      jwt-certs-url: "https://<provider-domain>/oauth2/keys"
      client-id: "application_identifier"
      client-secret: "your_client_secret"
      required-scopes: [ "profile", "email", "openid"]
      root-admin-emails:
        - "your.company.admin@example.com"
```

--------------------------------

### JSON AI Log Format Example

Source: https://www.jetbrains.com/help/ide-services/logging-of-ai-requests

An example of a JSON formatted log entry for AI requests, detailing correlation, protocol, method, path, headers, and body.

```json
{
    "correlation": "a56996318975f2f8",
    "protocol": "HTTP/1.1",
    "method": "GET",
    "path": "/api/ai/user/v5/llm/profiles",
    "attributes": {
        "userId": "5caeeae2-eb90-441d-9cfb-67bc9ec48d3c"
    },
    "headers": {
        "Authorization": [
            "XXX"
        ]
    },
    "body": "<body>"
}
```

--------------------------------

### HTTP AI Log Format Example

Source: https://www.jetbrains.com/help/ide-services/logging-of-ai-requests

An example of an HTTP formatted log entry for AI requests, showing the incoming request details including method, URL, headers, and attributes.

```http
Incoming Request: 96cd14698f9ff001
GET https://<serverURL>/api/ai/user/v5/llm/profiles HTTP/1.1
Authorization: XXX
Request Attribute `userId`: 6092281d-947a-4cf4-bb76-70332c94b595

<body>
```

--------------------------------

### Code With Me Distributions and Runtime Locations (macOS, Windows, Linux)

Source: https://www.jetbrains.com/help/ide-services/-cloud/getting-started-with-codewithme-for-business

This section details the file system paths where Code With Me client distributions and the JetBrains runtime are downloaded. It highlights potential differences in download locations based on the source (JetBrains Gateway/IDE Services vs. browser).

```text
macOS
Windows
Linux
~/Library/Caches/JetBrains/JetBrainsClientDist
~/Library/Caches/JetBrains/CodeWithMeClientDist
%LOCALAPPDATA%\JetBrains\JetBrainsClientDist
%LOCALAPPDATA%\JetBrains\CodeWithMeClientDist
~/.cache/JetBrains/JetBrainsClientDist
~/.cache/JetBrains/CodeWithMeClientDist
```

--------------------------------

### Get Windows Toolbox Installer

Source: https://www.jetbrains.com/help/ide-services/2025-2

Retrieves the Windows toolbox installer. A new 'build' query parameter has been added.

```APIDOC
## GET /api/toolbox/installer/windows

### Description
Retrieves the Windows toolbox installer.

### Method
GET

### Endpoint
/api/toolbox/installer/windows

### Parameters
#### Query Parameters
- **build** (string) - Required - The build version of the installer.
```

--------------------------------

### Example Calculation for IntelliJ IDEA Surcharge

Source: https://www.jetbrains.com/help/ide-services/-cloud/floating-licenses

Demonstrates the monthly surcharge calculation for IntelliJ IDEA based on a given annual price and concurrent license usage in a specific month.

```text
Surcharge in January =
= (USD 599 / 12) * 0.2 * 25
= USD 49.92 * 0.2 * 25
= USD 9.98 * 25
= USD 249.5
```

--------------------------------

### IDE Services Server Basic Configuration

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Example of a basic application.yaml file for configuring the IDE Services Server, including server port, database, storage, and authentication details.

```APIDOC
## Basic configuration
Create and fill in application.yaml following the example below. This example configuration only includes the required parameters.
> ### note
> The configuration format allows for using `${property references}`.
```yaml
server:
  port: 8080
  #ssl:
  #    enabled: true
  #    key-store-type: "PKCS12"
  #    key-store-password: "tbe-server"
tbe:
  deployment:
    url: "https://TODO" ### Use the public server URL here, https is highly advised

  db:
    host: "postgresql:5432"
    database: "toolbox"
    user: "username"
    password: "password"

  storage:
    type: s3

  minio:
    url: "https://minio"
    bucket: "toolbox"
    access-key: "username"
    secret-key: "password"
    # s3-region: 'eu-west-1' # optional

  auth:
    # See the examples of OAuth 2.0 service configuration
    login-url: "http://localhost:8085/auth/realms/toolbox/protocol/openid-connect/auth"
    token-url: "http://mock-auth:8085/auth/realms/toolbox/protocol/openid-connect/token"
    jwt-certs-url: "http://mock-auth:8085/auth/realms/toolbox/protocol/openid-connect/certs"
    client-id: "tbe-server"
    client-secret: "123456"
    root-admin-emails:
      - 'toolbox.admin@example.com'

springdoc:
  api-docs:
    enabled: true # Enable OpenAPI documentation at /swagger-ui.html

logging:
  level:
    root: INFO # can be changed to WARN/DEBUG/TRACE
```
```

--------------------------------

### IDE Services Code With Me Configuration

Source: https://www.jetbrains.com/help/ide-services/enable-cwm

Example configuration for enabling and setting up Code With Me within the IDE Services Server's application.yaml file. It includes enabling the lobby, setting the session base URL, configuring STUN/TURN servers, and specifying the ECDSA private key.

```yaml
cwm:
  lobby:
    enabled: true
    session-base-url: '${tbe.deployment.url}/code-with-me'
    relay-config:
      stunTurnServers:
        - uri: stun:stun.l.google.com:PORT
      relays:
        - regionName: region1
          latitude: 0
          longitude: 0
          servers:
            - wss://RELAY_SERVER_HOSTNAME
      relay-ecdsa-key: |-
        -----BEGIN EC PRIVATE KEY-----
      PRIVATE KEY FROM STEP 1
      -----END EC PRIVATE KEY-----
```

--------------------------------

### Guest Code With Me Setup Locations

Source: https://www.jetbrains.com/help/ide-services/getting-started-with-codewithme-for-business

Details the file system paths for Code With Me logs, caches, settings, and distributions across macOS, Windows, and Linux. It differentiates between distributions downloaded via JetBrains Gateway/IDE Services and those from a browser.

```path
macOS
Windows
Linux
`~/Library/Logs/JetBrains/JetBrainsClient<plugin_version>`
`%LOCALAPPDATA%\JetBrains\JetBrainsClient<plugin_version>\log`
`~/.cache/JetBrains/JetBrainsClient<plugin_version>/log`
```

```path
macOS
Windows
Linux
`~/Library/Caches/JetBrains/JetBrainsClient<plugin_version>`
`%LOCALAPPDATA%\JetBrains\JetBrainsClient<plugin_version>`
`~/.cache/JetBrains/JetBrainsClient<plugin_version>`
```

```path
macOS
Windows
Linux
`~/Library/Application\ Support/JetBrains/JetBrainsClient<plugin_version>`
`%APPDATA%\Roaming\JetBrains\JetBrainsClient<plugin_version>`
`~/.config/JetBrains/JetBrainsClient<plugin_version>`
```

```path
macOS
Windows
Linux
`~/Library/Caches/JetBrains/JetBrainsClientDist`
`~/Library/Caches/JetBrains/CodeWithMeClientDist`
`%LOCALAPPDATA%\JetBrains\JetBrainsClientDist`
`%LOCALAPPDATA%\JetBrains\CodeWithMeClientDist`
`~/.cache/JetBrains/JetBrainsClientDist`
`~/.cache/JetBrains/CodeWithMeClientDist`
```

```path
macOS
Windows
Linux
`~/Library/Application Support/JetBrains/Toolbox/internal-tools/JetBrains Client`
`%LOCALAPPDATA%\JetBrains\Toolbox\internal-tools\JetBrains Client`
`~/.local/share/JetBrains/Toolbox/internal-tools/JetBrains Client`
```

--------------------------------

### Get All AI Providers

Source: https://www.jetbrains.com/help/ide-services/2025-4-2

Retrieves a list of all configured AI providers.

```APIDOC
## GET /api/constituents/ai

### Description
Fetches a list of all available AI providers and their configurations.

### Method
GET

### Endpoint
/api/constituents/ai

### Response
#### Success Response (200)
- **providers** (array) - A list of AI provider objects.
  - **providerId** (string) - The unique identifier for the AI provider.
  - **providerName** (string) - The name of the AI provider.
  - **modelName** (string) - The model name associated with the provider.

#### Response Example
```json
{
  "providers": [
    {
      "providerId": "provider-123",
      "providerName": "OpenAI",
      "modelName": "GPT-4"
    },
    {
      "providerId": "provider-789",
      "providerName": "Azure OpenAI",
      "modelName": "GPT-5"
    }
  ]
}
```
```

--------------------------------

### Code With Me Enterprise Configuration

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Configuration parameters for enabling and setting up the Code With Me Enterprise product within IDE Services.

```APIDOC
### Code With Me Enterprise
cwm.lobby.enabled
    
Enables the Code With Me Enterprise product in IDE Services.cwm.lobby.relay-config
    
Specify the relay server configuration.cwm.lobby.relay-ecdsa-key
    
Specify your ECDSA private key without any passphrase to prevent unauthorized access to a relay server.
The length of the ECDSA private key file is 384-bit. The format of this file is PEM, and the file can be generated with OpenSSL.
```

--------------------------------

### Configure CDN Redirect Mode for Plugins

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Define how IDE Services handles plugin download requests from the Toolbox App. 'redirect_to_service' sends requests directly to the binary source, while 'handle_redirects' uses the IDE Services Server as a proxy.

```properties
tbe.tbe-ij-plugin.cdn-redirect-mode=redirect_to_service
```

```properties
tbe.tbe-ij-plugin.cdn-redirect-mode=handle_redirects
```

--------------------------------

### Basic IDE Services Server Configuration (YAML)

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Provides a foundational `application.yaml` structure for the IDE Services Server. This configuration includes essential settings for the server port, database connection details (PostgreSQL), object storage (S3/Minio), authentication endpoints, and OpenAPI documentation enablement. It also shows root logging level.

```yaml
server:
  port: 8080
  #ssl:
  #    enabled: true
  #    key-store-type: "PKCS12"
  #    key-store-password: "tbe-server"
tbe:
  deployment:
    url: "https://TODO" ### Use the public server URL here, https is highly advised

  db:
    host: "postgresql:5432"
    database: "toolbox"
    user: "username"
    password: "password"

  storage:
    type: s3

  minio:
    url: "https://minio"
    bucket: "toolbox"
    access-key: "username"
    secret-key: "password"
    # s3-region: 'eu-west-1' # optional

  auth:
    # See the examples of OAuth 2.0 service configuration
    login-url: "http://localhost:8085/auth/realms/toolbox/protocol/openid-connect/auth"
    token-url: "http://mock-auth:8085/auth/realms/toolbox/protocol/openid-connect/token"
    jwt-certs-url: "http://mock-auth:8085/auth/realms/toolbox/protocol/openid-connect/certs"
    client-id: "tbe-server"
    client-secret: "123456"
    root-admin-emails:
      - 'toolbox.admin@example.com'

springdoc:
  api-docs:
    enabled: true # Enable OpenAPI documentation at /swagger-ui.html

logging:
  level:
    root: INFO # can be changed to WARN/DEBUG/TRACE
```

--------------------------------

### Update Constituents CWM Endpoint (GET)

Source: https://www.jetbrains.com/help/ide-services/2024-4

Updates the GET /api/constituents/cwm endpoint by adding a required 'activeUsers' property to the response.

```HTTP
GET /api/constituents/cwm
Response includes: activeUsers (required)
```

--------------------------------

### Server Configuration Parameters

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Configuration parameters for the embedded server, including port settings and SSL support.

```APIDOC
### Server
This group of properties allows for embedded server configuration. For more information, refer to the Spring Boot documentation.server.port
    
Specify a server HTTP port.server.ssl.enabled
    
Enables SSL support.server.ssl.key-store-type
    
Specify a type of the key store: `JKS` or `PKCS12`.server.ssl.key-store-password
    
Provide a password to access the key store.
```

--------------------------------

### Update Constituents AI Endpoint (GET)

Source: https://www.jetbrains.com/help/ide-services/2024-4

Details changes to the GET /api/constituents/ai endpoint, including optional and required properties added to the response.

```HTTP
GET /api/constituents/ai
Response includes:
  provider/jetbrains/enableCloneFinder (optional)
  allowDataCollection (required)
  availableProviders (required)
  defaultProvider (required)
```

--------------------------------

### Enabling SSL Support (YAML)

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Shows how to enable SSL (Secure Sockets Layer) for the server, which is crucial for secure communication. It includes parameters for key store type and password.

```yaml
server:
  ssl:
    enabled: true
    key-store-type: "PKCS12"
    key-store-password: "tbe-server"
```

--------------------------------

### Update Automation Tokens Endpoint (GET by ID)

Source: https://www.jetbrains.com/help/ide-services/2024-4

Updates the GET /api/automation-tokens/{id} endpoint by adding a required 'state' property to the response.

```HTTP
GET /api/automation-tokens/{id}
Response includes: state (required)
```

--------------------------------

### Example Plugin Download Log (JSON)

Source: https://www.jetbrains.com/help/ide-services/object-storage

Illustrates the JSON format of plugin download logs, showing details like plugin ID, name, version, timestamp, and the user agent that initiated the download. This format is used for auditing and tracking plugin usage.

```json
{
    "events" : [ {
        "pluginId" : "org.jetbrains.toolbox-enterprise-client",
        "pluginName" : "Toolbox Enterprise",
        "pluginVersion" : "2024.3.0.1622-ij233",
        "timestamp" : "2024-03-20T00:00:00Z",
        "userAgent" : "Toolbox/2.2.3.20090 (Mac OS X)"
    } ]
}
```

--------------------------------

### Enable API Documentation (Swagger)

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Enable or disable the generation of API documentation using Swagger for your server. This allows for interactive API exploration.

```properties
springdoc.api-docs.enabled=true
```

```properties
springdoc.api-docs.enabled=false
```

--------------------------------

### Enable Logging for IDE and Plugin Downloads (application.yaml)

Source: https://www.jetbrains.com/help/ide-services/advanced-configuration

Enable tracking of IDE and plugin downloads by setting the 'tbe.features.log-binary-downloads' parameter to true in application.yaml. Ensure the root logging level is set to INFO.

```yaml
tbe.features.log-binary-downloads: true

logging:
    level:
        root: INFO
```

--------------------------------

### Add Constituents AI Providers Endpoint (GET)

Source: https://www.jetbrains.com/help/ide-services/2024-4

Introduces a new GET endpoint for retrieving AI providers. No specific dependencies or input/output details are provided.

```HTTP
GET /api/constituents/ai/providers/{providerId}
```

--------------------------------

### Modify Automation Tokens Endpoint (GET)

Source: https://www.jetbrains.com/help/ide-services/2024-4

Updates the GET /api/automation-tokens endpoint by adding an optional 'state' query parameter and a required 'items/state' property to the response.

```HTTP
GET /api/automation-tokens?state=<optional_state>
Response includes: /items/state (required)
```

--------------------------------

### Calculate IDE Provisioner Quarterly Billing

Source: https://www.jetbrains.com/help/ide-services/-cloud/license-plans

Demonstrates the calculation of quarterly billable usage for IDE Provisioner. It sums the highest daily usage from each month and multiplies by the monthly subscription price.

```text
(108 + 104 + 106) * $10.00 = USD 3,180.00
```

--------------------------------

### Manage IDE Services Demo with Docker Compose

Source: https://www.jetbrains.com/help/ide-services/try-demo

Provides commands to check the status, stop, and clean up the IDE Services Demo running with Docker Compose.

```bash
docker compose ps
```

```bash
docker compose stop
```

```bash
docker compose down -v
```

--------------------------------

### Splunk AI Log Format Example

Source: https://www.jetbrains.com/help/ide-services/logging-of-ai-requests

An example of a Splunk formatted log entry for AI requests, summarizing request details in a key-value pair format suitable for Splunk.

```splunk
origin=remote type=request correlation=baa0fe4c12598729 protocol=HTTP/1.1 method=GET path=/api/ai/user/v5/llm/profiles attributes={userId=dca1270f-1e6d-4518-a49d-b48cf38ad7f0} headers={Authorization=[XXX]} body={<body>}
```

--------------------------------

### API Change: GET /api/profiles/{id}

Source: https://www.jetbrains.com/help/ide-services/whats-new

Updates to the GET /api/profiles/{id} endpoint, adding new optional response properties related to autoinstalled tools and Toolbox App settings.

```json
{
  "response": {
    "200": {
      "applications/content/items/autoinstalled": "optional",
      "settings/autoinstalledTools": "optional",
      "settings/autoinstalledToolsVersion": "optional",
      "settings/toolbox": "optional",
      "settings/toolboxVersion": "optional"
    }
  }
}
```

--------------------------------

### POST /api/license/public-key

Source: https://www.jetbrains.com/help/ide-services/2024-3-4-whats-new

An endpoint has been added to manage public keys for licensing.

```APIDOC
## POST /api/license/public-key

### Description
This endpoint is used for managing public keys related to product licensing.

### Method
POST

### Endpoint
/api/license/public-key

### Parameters
#### Request Body
- **publicKey** (string) - Required - The public key data.
- **keyId** (string) - Required - The unique identifier for the public key.

### Request Example
```json
{
  "publicKey": "-----BEGIN PUBLIC KEY-----\nMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE...\n-----END PUBLIC KEY-----",
  "keyId": "abc123xyz789"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation (e.g., 'success', 'failed').
- **message** (string) - Provides details about the operation's outcome.
```

--------------------------------

### Configuring Code With Me Enterprise (YAML)

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Details the configuration parameters for enabling and setting up the Code With Me Enterprise product within IDE Services. This includes enabling the lobby and configuring relay server details.

```yaml
cwm.lobby.enabled
    
    Enables the Code With Me Enterprise product in IDE Services.
cwm.lobby.relay-config
    
    Specify the relay server configuration.
cwm.lobby.relay-ecdsa-key
    
    Specify your ECDSA private key without any passphrase to prevent unauthorized access to a relay server.
The length of the ECDSA private key file is 384-bit. The format of this file is PEM, and the file can be generated with OpenSSL.
```

--------------------------------

### Configure SSL for Postgres Database Access

Source: https://www.jetbrains.com/help/ide-services/advanced-configuration

Enable SSL certificates for database access by configuring the application.yaml file. Ensure these lines have no indent when used with other options. Supports different SSL modes like VERIFY-FULL and REQUIRE.

```yaml
spring:
  r2dbc:
    ssl: true
    properties.sslMode: VERIFY-FULL
    properties.sslRootCert: "<path to PEM certificates in the container>"
```

--------------------------------

### Optional 'prevUser' in GET /api/users/{userId}/audit-logs

Source: https://www.jetbrains.com/help/ide-services/2025-2

The 'prevUser' property within the 'items/items/content/updated' object for the GET /api/users/{userId}/audit-logs endpoint is now optional for a '200' status response. This affects the audit log retrieval.

```HTTP
GET /api/users/{userId}/audit-logs

```

--------------------------------

### Test Facebook Authentication Connection

Source: https://www.jetbrains.com/help/ide-services/-cloud/bitbucket-cloud-auth-module

Verify the correct setup of the Facebook authentication module by testing the connection. This action initiates a login process in a new browser tab.

```APIDOC
## Test the Connection

### Description
Tests the connection to the Facebook authentication module to verify its setup.

### Method
GET

### Endpoint
/facebook/test-login

### Response
#### Success Response (200)
- **message** (string) - "Success message indicating the connection is set up correctly."

#### Error Response (400/500)
- **error** (string) - "Error message providing details about connection problems."
```

--------------------------------

### Configure IDE Services Deployment

Source: https://www.jetbrains.com/help/ide-services/set-up-server

Properties to specify the public URL for accessing IDE Services' Web UI and to define allowed origins for CORS.

```properties
tbe.deployment.url=https://ide-services.example.com
tbe.deployment.allowed-origins=https://app.example.com,https://another.app.com
```

--------------------------------

### Example User Access Analytics Response

Source: https://www.jetbrains.com/help/ide-services/user-access-analytics

An example JSON response from the user access analytics endpoint, showing user details and flags indicating access to various IDE Services components. Older versions may only include 'hasRequestedFromTBA' and 'hasRequestedFromIde'.

```JSON
{
    "date": "2025-05-07",
    "userId": "12fd2851-9519-4a6f-abcb-cd67854570f3",
    "userEmail": "toolbox.admin@example.com",
    "hasRequestedFromTBA": true,
    "hasRequestedFromIde": true,
    "hasRequestedFromLv": true,
    "hasRequestedFromAi": true,
    "hasRequestedFromCwm": true
}
```

--------------------------------

### Deploy JetBrains Mellum using Helm

Source: https://www.jetbrains.com/help/ide-services/jetbrains-mellum

This command deploys JetBrains Mellum using Helm charts. Ensure you have configured your values.yaml file and have the necessary Helm repository added.

```shell
helm install jb-ide-services jetbrains-ide-services/ide-services-helm --version 2025.4.2 --namespace kube-ide-services -f values.yaml
```

--------------------------------

### IDE Services Application Parameters

Source: https://www.jetbrains.com/help/ide-services/values-file

Configuration parameters for the IDE Services Helm chart.

```APIDOC
## Application Parameters

### Description
Configurable parameters for the IDE Services Helm chart, including Java options, environment variables, URLs, CORS settings, logging levels, plugin sources, secrets, and general configuration.

### Parameters
#### Application Parameters

- **ides.config.javaOpts** (string) - Optional - Specify additional Java options to pass to the application container.
- **ides.config.additionalEnvs** (object) - Optional - Specify additional environmental variables to pass to the application container.
- **ides.config.deploymentURL** (string) - Optional - Specify a public URL to access IDE Services's Web UI.
- **ides.config.allowedOrigins** (array of strings) - Optional - Provide a list of CORS origins allowed by the IDE Services Server.
- **ides.config.loggingLevel** (string) - Optional - Set the highest logging level to display in the logs. Possible values include `WARN` to disable logging.
- **ides.config.intellijPlugin.pluginRepositoryType** (string) - Optional - Specify the source for obtaining plugins. Possible values: `TBE` (local repository, offline mode), `MARKETPLACE` (external marketplace).
- **ides.config.additionalSecrets** (array of objects) - Optional - Specify additional secrets. Each object should have `suffix` (string) and `secretName` (string).
  * Example:
    ```yaml
    additionalSecrets:
      - suffix: "okta"
        secretName: "company-okta-secret"
    ```
- **ides.config.configCustomization** (object) - Optional - Pass any configurations supported by `application.yaml`. Values here override existing configurations.
  * Example for SSL with PostgreSQL:
    ```yaml
    spring:
      r2dbc:
        ssl: true
        properties.sslMode: VERIFY-FULL
        properties.sslRootCert: "<path to PEM certificates in the container>"
    ```
    * `properties.sslMode` possible values: `VERIFY-FULL` (requires `sslRootCert`), `REQUIRE`.
```

--------------------------------

### API Constituents AI Endpoint GET Changes

Source: https://www.jetbrains.com/help/ide-services/2024-3-general-availability

Details changes to the GET /api/constituents/ai endpoint. Breaking changes include the removal of 'id' and 'url' properties from the '200' response. New optional property 'assignedUsersLimit' was added, and several properties became required for the '200' status.

```HTTP
GET /api/constituents/ai
// Breaking changes: 'id', 'url' removed from '200' response.
// Added optional 'assignedUsersLimit' to '200' response.
// Properties 'activeIdeProfilesCount', 'activeUsersCount', 'disabledByLimitsUsersCount', 'provider' became required for '200' status.
// Added required 'activeIdeProfilesCount', 'activeUsersCount', 'disabledByLimitsUsersCount', 'provider' to '200' response.
```

--------------------------------

### IDE Services Database Parameters

Source: https://www.jetbrains.com/help/ide-services/values-file

Database configuration parameters for IDE Services.

```APIDOC
## Database Parameters

### Description
Configuration parameters for connecting IDE Services to a PostgreSQL database.

### Parameters
#### Database Parameters

- **ides.config.db.host** (string) - Required - Specify a PostgreSQL host.
- **ides.config.db.database** (string) - Required - Specify the name of the PostgreSQL database.
- **ides.config.db.schema** (string) - Optional - Specify a PostgreSQL schema. Defaults to `public`.
- **ides.config.db.user** (string) - Required - Specify a username to connect to the PostgreSQL database.
- **ides.config.db.password** (string) - Required - Specify a password to connect to the PostgreSQL database.
- **ides.config.db.secretName** (string) - Required (if using secrets) - Specify the name of an existing user secret containing database details.
  * Note: If using a secret, other `ides.config.db` parameters are not needed.
  * Secret Format Example:
    ```yaml
    apiVersion: v1
    kind: Secret
    type: Opaque
    metadata:
      name: <secret-name>
    data:
      host: ""
      database: ""
      user: ""
      password: ""
    ```
```

--------------------------------

### GET /api/usage-stats/recalculate

Source: https://www.jetbrains.com/help/ide-services/whats-new

Recalculates usage statistics.

```APIDOC
## GET /api/usage-stats/recalculate

### Description
Recalculates usage statistics.

### Method
GET

### Endpoint
/api/usage-stats/recalculate

### Parameters

### Request Example

### Response
#### Success Response (200)

#### Response Example

```

--------------------------------

### GET /api/plugins-channels

Source: https://www.jetbrains.com/help/ide-services/whats-new

Retrieves plugin channels.

```APIDOC
## GET /api/plugins-channels

### Description
Retrieves plugin channels.

### Method
GET

### Endpoint
/api/plugins-channels
```
Tokens:
Raw