IDE Services 2024.3 Help

REST API

IDE Services provides both a user interface (Web UI) and application programming interface (API) to execute all essential operations on the IDE Services Server.

Automation Tokens

Most requests to the IDE Services Server require the Authorization header. It supports:

  • OAuth 2.0 tokens from the external OAuth2 service provider used in your company

  • Automation tokens created on the IDE Services Server

Add an automation token

Create an automation token

  1. In the Web UI, open the Configuration page and navigate to the Automation Tokens tab.

  2. Click Create Automation Token.

  3. In the Create Automation Token dialog, specify the token name in the Client ID field, and set the expiration date for the token.

    New automation token

Swagger Documentation

The Swagger pages are disabled by default on the server. Add the following lines to IDE Services's application.yaml to enable Swagger:

springdoc: api-docs: enabled: true

The Swagger API documentation is available at https://<your_organization>/swagger-ui.html.

Last modified: 13 May 2024