YouTrack Standalone 2018.3 Help

REST API

With the release of YouTrack 2018.3 we started to gradually publish new REST API resources and methods. The new REST API is in active development and may be changed. In these terms the gradual publishing of the new resources and methods may be regarded as an Early Access Program.

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

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

  • Creating, modifying, and performing other operations programmatically — so you can seamlessly integrate YouTrack into your environment. For example, via automated issue submission from third-party applications.

  • Manipulating projects, users, groups, roles, issue link types, and custom attributes.

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.

To test the REST API, enter the base URL for your YouTrack service in your browser, followed by /api/admin/users/me. For YouTrack InCloud instances, your base URL includes the trailing /youtrack. For example:

https://example.myjetbrains.com/youtrack/api/admin/users/me
If you have sufficient access permissions, the minimal JSON representation for the current user profile is displayed in your browser as shown here:

Basic rest test

Even though the REST API is always on, an administrator can specify which sites (origins) are allowed to access YouTrack via REST. For more information, see REST API.

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:

Last modified: 12 October 2018