YouTrack Standalone 2020.3 Help

REST API

YouTrack REST API lets you perform programmatically various actions in the tracker:

  • Import issues from your current bug tracking system — for smoother migration to YouTrack.

  • Create, modify, and perform other operations with issues — so you can seamlessly integrate YouTrack into your environment. For example, via automated issue submission from third-party applications.

  • Manipulate projects, custom fields and sets of values, agile boards, issue link types, and other parameters.

General Notes

The REST API returns and consumes data in JSON format. Regular content negotiation rules apply:

  • Use the Accept HTTP request header to indicate the expected response data format: application/json

  • Use the Content-Type HTTP request header for POST and PUT requests: application/json

The REST API is always enabled. However, a system administrator can specify which sites (origins) are allowed to access YouTrack using REST. For more information, see Resource Sharing.

Tools and Client Libraries Based on the YouTrack REST API

Before you start using the REST API for your own development, take a look at a few tools that use the YouTrack REST API:

  • The YouTrack REST API client library for Python uses the REST API to import data from other issue trackers.

  • YouTrack REST API PHP Client is a PHP client library for the YouTrack REST API.

  • YouTrackSharp is a .NET library for accessing the YouTrack REST API. This library is also available from the NuGet gallery.
  • YouTrack Mobile uses the REST API to pull data from a YouTrack installation and display it in a mobile app.

  • YouTrack Integration Plugin for IntelliJ IDEA and other JetBrains IDEs uses the REST API to display issue-related information directly in an IDE.

Last modified: 8 September 2020