YouTrack Server 2022.1 Help

Monitor REST API Traffic

The Deprecated REST API Traffic section on the Server Configuration tab of the Global Settings page displays a list of recent requests that have been sent to endpoints that are supported by the deprecated REST API.

The old version of the YouTrack REST API was initially deprecated with the release of YouTrack version 2018.3. In the upcoming 2021.3 release, support for this version of the API will be discontinued. This means that its endpoints will be deactivated to ignore incoming requests.

After the YouTrack 2021.3 release, all third-party integrations and external client applications must use the current YouTrack REST API.

To help you identify external apps that still rely on the old REST API, we introduced an audit tool that monitors traffic to deprecated endpoints. Use this information to locate business-critical integrations that haven't been upgraded to use the current API and prioritize their migration.

To locate this information, open the Server Settings > Global Settings page, then scroll down to the Deprecated REST API Traffic section of the Server Configuration tab.

Deprecated REST API traffic.

If your system has not received any incoming requests to deprecated endpoints following the introduction of the monitoring feature in the 2021.2 release, this section of the page is not shown. For systems that have detected traffic to deprecated endpoints, the following information is displayed:

Value

Description

Date

The date and time when the API request was received by YouTrack.

IP Address

The unique address that identifies the origin of the request.

User

The username of the account that was used to authenticate the API request.

Path

The target endpoint of the API request.

User Agent

The value that was provided for the User-Agent request header in the API call. This information helps to identify the application, operating system, vendor, and/or application version of the requesting user agent.

Response

The HTTP status code that was issued in response to the incoming request.

Last modified: 06 July 2022