YouTrack Standalone 2019.2 Help

Operations with Specific SystemSettings

This resource lets you work with the System settings of your YouTrack service.

Resource

/api/admin/globalSettings/systemSettings

Returned entity

SystemSettings. For the description of the entity attributes, see Supported Fields section.

Supported methods

SystemSettings attributes

Represents the System settings that affect core functionality of YouTrack.

This table describes attributes of the SystemSettings entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

baseUrl

String

Base URL of the YouTrack installation. Can be null.

maxUploadFileSize

Long

Maximum size of the file that can be uploaded.

maxExportItems

Int

Maximum number of issues that can be exported.

administratorEmail

String

Email of server administrator. Can be null.

allowStatisticsCollection

Boolean

Indicates whether it is allowed to collect usage statistics.

isApplicationReadOnly

Boolean

true, if the application is currently in the read-only mode. Otherwise, false.

Read a Specific SystemSettings

Read the System settings of your YouTrack service.

Request syntax

GET /api/admin/globalSettings/systemSettings?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of SystemSettings attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/globalSettings/systemSettings?fields=baseUrl,maxUploadFileSize,maxExportItems,allowStatisticsCollection,isApplicationReadOnly

Sample response body

{ "maxUploadFileSize": 10485760, "isApplicationReadOnly": false, "maxExportItems": 500, "allowStatisticsCollection": true, "baseUrl": "https://example.myjetbrains.com/youtrack", "$type": "SystemSettings" }

Update a Specific SystemSettings

Change the System settings of your YouTrack service.

Request syntax

POST /api/admin/globalSettings/systemSettings?{fields}

Request parameters

Parameter

Type

Description

fields

String

A list of SystemSettings attributes that should be returned in the response. If no field is specified,only the entityID is returned

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/globalSettings/systemSettings?fields=baseUrl,maxUploadFileSize,maxExportItems,allowStatisticsCollection,isApplicationReadOnly

Sample request body

{ "maxUploadFileSize": 20971520, "maxExportItems": 250 }

Sample response body

{ "maxUploadFileSize": 20971520, "isApplicationReadOnly": false, "maxExportItems": 250, "allowStatisticsCollection": true, "baseUrl": "https://example.myjetbrains.com/youtrack", "$type": "SystemSettings" }
Last modified: 22 October 2019