REST API URL and Endpoints
YouTrack's REST API is available by the following URL:
YouTrack Server REST API URL
<YouTrack Service URL> is the base URL of the YouTrack service in your network environment. For example, you have your company's server www.example.com and a YouTrack service. You can configure YouTrack to be accessible by www.example.com/youtrack or, let's say youtrack.example.com.
/api is the context path for the REST API of your YouTrack service. Append this path to the YouTrack service URL to get the URL for the REST API.
For the sample service URLs above, REST API URLs are as follows:
YouTrack Service URL | YouTrack REST API URL |
|---|---|
https://www.example.com/youtrack | https://www.example.com/youtrack/api |
https://youtrack.example.com | https://youtrack.example.com/api |
Here are the examples of the endpoint URLs to get the profile of the current user:
For
www.example.com/youtrack:https://www.example.com/youtrack/api/admin/users/meFor
youtrack.example.com:https://youtrack.example.com/api/admin/users/me
YouTrack Cloud REST API URL
<YouTrack Service URL> is the base URL of your YouTrack Cloud instance.
If your YouTrack Cloud instance is hosted on myjetbrains.com, its service URL must have the /youtrack context appended. For example, https://example.myjetbrains.com/youtrack.
/api is the context path for the REST API of your YouTrack service. Append this path to the YouTrack service URL to get the URL for the REST API.
For the instances hosted on default YouTrack Cloud domains, REST API URLs are as follows:
YouTrack Service URL | YouTrack REST API URL |
|---|---|
https://example.youtrack.cloud | https://example.youtrack.cloud/api |
https://example.myjetbrains.com/youtrack | https://example.myjetbrains.com/youtrack/api |
Here are the examples of the endpoint URLs to get the profile of the current user:
For
example.youtrack.cloud:https://example.youtrack.cloud/api/admin/users/meFor
example.myjetbrains.com:https://example.myjetbrains.com/youtrack/api/admin/users/me