YouTrack

https://www.jetbrains.com/help/youtrack/
Admin
YouTrack is a JetBrains issue tracking and project management platform that enables teams to manage...
Tokens:3,944,293
Snippets:26,278
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example configure command for JVM option

Source: https://www.jetbrains.com/help/youtrack/server/configure-jvm-options.html

Example of setting a JVM option using the configure command. This sets the statistics-upload property to true.

```bash
configure -J-Dstatistics-upload=true
```

--------------------------------

### Install YouTrack packages globally

Source: https://www.jetbrains.com/help/youtrack/devportal/js-workflow-external-editor.html.md

Install the workflow API and app tools packages globally using npm. This is the easiest way to get started.

```SHELL
npm install -g @jetbrains/youtrack-scripting-api
npm install -g @jetbrains/youtrack-apps-tools
```

--------------------------------

### slice(start, end) - Extract Set portion

Source: https://www.jetbrains.com/help/youtrack/devportal/v1-Set.html.md

Creates a shallow copy of a portion of a Set as an array. Available since 2025.3. Negative start values are treated as 0. The example gets the first three subtasks.

```javascript
slice(start, end)
```

```javascript
// Get first 3 subtasks
const firstThree = issue.links['parent for'].slice(0, 3);
```

--------------------------------

### Sample POST request for creating a build bundle

Source: https://www.jetbrains.com/help/youtrack/devportal/resource-api-admin-customFieldSettings-bundles-build.html

Example request URL for creating a new build bundle. Requires Update Project or Low-level Admin Write permissions.

```http
https://example.youtrack.cloud/api/admin/customFieldSettings/bundles/build
```

--------------------------------

### intervalToWorkingMinutes(start, end)

Source: https://www.jetbrains.com/help/youtrack/devportal/v1-Project.html.md

Gets the number of minutes that occurred during working hours in a specified interval. For example, if the interval is two days and the number of working hours in a day is set to 8, the result is 2 * 8 * 60 = 960.

```APIDOC
## intervalToWorkingMinutes(start, end)

### Description
Gets the number of minutes that occurred during working hours in a specified interval. For example, if the interval is two days and the number of working hours in a day is set to 8, the result is 2 * 8 * 60 = 960.

### Method
Function

### Endpoint
intervalToWorkingMinutes(start, end)

### Parameters
- **start** (Number) - Required - Start of the interval.
- **end** (Number) - Required - End of the interval.

### Return Value
- **Number** - The number of minutes that occurred during working hours in the specified interval.
```

--------------------------------

### Sample GET request for DatabaseBackupSettings

Source: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-databaseBackup-settings.html

Example URL that requests specific fields including backupStatus sub-fields.

```http
https://example.youtrack.cloud/api/admin/databaseBackup/settings?fields=archiveFormat,availableDiskSpace,backupStatus(backupCancelled,backupError(date,errorMessage),backupInProgress,stopBackup),isOn,location,cronExpression,filesToKeep,notifiedUsers(login,name,id)
```

--------------------------------

### Sample GET response body for DatabaseBackupSettings

Source: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-databaseBackup-settings.html

Example JSON response showing all requested fields, including backupStatus and notifiedUsers.

```json
{
  "cronExpression": "0 0 9 * * ?",
  "isOn": false,
  "notifiedUsers": [
    {
      "login": "root",
      "name": "John Smith",
      "id": "1-1",
      "$type": "User"
    }
  ],
  "archiveFormat": "TAR_GZ",
  "filesToKeep": 0,
  "availableDiskSpace": 57364168704,
  "backupStatus": {
    "stopBackup": false,
    "backupInProgress": false,
    "backupError": null,
    "backupCancelled": false,
    "$type": "BackupStatus"
  },
  "location": "/mnt/disk0/example/backup",
  "$type": "DatabaseBackupSettings"
}
```

--------------------------------

### Service output example

Source: https://www.jetbrains.com/help/youtrack/server/deploy-youtrack-kubernetes.html

Example output from the kubectl get service command.

```text
NAME              CLUSTER-IP    EXTERNAL-IP     PORT(S)          AGE
                    hello-app-service  10.3.251.122    213.1.234.0  80:30878/TCP     11s
```

--------------------------------

### fetchHub GET request example

Source: https://www.jetbrains.com/help/youtrack/devportal/apps-host-api.html

Fetches data from the Hub service using a GET request. The example calls the 'api/rest/users/me' endpoint with fields for name, login, and profile avatar URL, and logs the response.

```typescript
CustomWidgetAPILayer.fetchHub('api/rest/users/me?fields=name,login,profile(avatar(url))')
    .then(response => console.log(response));
```

--------------------------------

### Sample POST request for DatabaseBackupSettings

Source: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-databaseBackup-settings.html

Example URL that requests specific fields after updating.

```http
https://example.com/youtrack/api/admin/databaseBackup/settings?fields=archiveFormat,availableDiskSpace,backupStatus(backupCancelled,backupError(date,errorMessage),backupInProgress,stopBackup),isOn,filesToKeep,cronExpression,notifiedUsers(id,name,login)
```

--------------------------------

### Sample POST response body for DatabaseBackupSettings

Source: https://www.jetbrains.com/help/youtrack/devportal/operations-api-admin-databaseBackup-settings.html

Example JSON response after updating, showing the updated settings.

```json
{
  "isOn": true,
  "cronExpression": "0 0 2 * * ?",
  "filesToKeep": 30,
  "archiveFormat": "TAR_GZ",
  "availableDiskSpace": 115498954752,
  "notifiedUsers": [
    {
      "name": "TARDIS",
      "login": "admin",
      "id": "24-0",
      "$type": "User"
    }
  ],
  "backupStatus": {
    "backupInProgress": false,
    "stopBackup": false,
    "backupCancelled": false,
    "backupError": null,
    "$type": "BackupStatus"
  },
  "$type": "DatabaseBackupSettings"
}
```

--------------------------------

### GET /api/articles

Source: https://www.jetbrains.com/help/youtrack/devportal/resource-api-articles.html.md

This snippet documents the GET /api/articles endpoint, including its query parameters, request example, and response structure.

```APIDOC
## GET /api/articles

### Description
Retrieves a list of articles from the YouTrack knowledge base. This endpoint supports pagination and field selection to control the response content.

### Method
GET

### Endpoint
/api/articles

### Parameters
#### Query Parameters
- **fields** (String) - Optional - A list of Article attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.
- **$skip** (Int) - Optional - Lets you set a number of returned entities to skip before returning the first one.
- **$top** (Int) - Optional - Lets you specify the maximum number of entries that are returned in the response. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections.

### Request Example
```curl
https://example.youtrack.cloud/api/articles?fields=hasStar,content,created,updated,id,idReadable,reporter(name),summary,project(shortName),content
```

### Response
#### Success Response (200)
Returns an array of Article objects. Each Article object contains the following fields (when requested):
- **created** (Long) - Timestamp of article creation.
- **project** (Project) - The project the article belongs to, with a `shortName` field.
- **idReadable** (String) - The readable ID of the article (e.g., "NP-A-1").
- **updated** (Long) - Timestamp of the last update.
- **hasStar** (Boolean) - Indicates whether the article is starred.
- **content** (String) - The content of the article.
- **summary** (String) - The summary of the article.
- **reporter** (User) - The user who reported the article, with a `name` field.
- **id** (String) - The internal ID of the article.
- **$type** (String) - The type of the entity (e.g., "Article").

#### Response Example
```json
[
  {
    "created": 1593001508713,
    "project": {
      "shortName": "NP",
      "$type": "Project"
    },
    "idReadable": "NP-A-1",
    "updated": 1605620052796,
    "hasStar": true,
    "content": "## Write it all down\n\nA knowledge base is a great tool for sharing information. When you record your experiences and insights regularly, other members of your team reap the rewards.\n\n## Enrich the content\n\n",
    "summary": "Getting Started with Articles in YouTrack",
    "reporter": {
      "name": "John Smith",
      "$type": "User"
    },
    "id": "226-0",
    "$type": "Article"
  }
]
```
```

--------------------------------

### List syntax examples

Source: https://www.jetbrains.com/help/youtrack/cloud/youtrack-markdown-syntax-issues.html

These examples show the rules for ordered lists in YouTrack. The first list must start with 1 and uses the same delimiter. The second list can start with any number and uses a different delimiter, but numbering continues from the previous item.

```markdown
1. Only lists that start with 1 are allowed to interrupt paragraphs.
1. Subsequent numbering is irrelevant.
0. You can start a new line with any number as long as you use the same delimiter character.
2) This item uses a different delimiter and starts a new ordered list, starting with the number 2.
```

```markdown
4) The empty line means that the list does not interrupt a paragraph.
1) The ordered list continues to increment the numbering from the previous list item.
123456789) Use any number fewer than ten characters. This number is parsed as the third item in the ordered list.
```
Tokens:
Raw