YouTrack InCloud 2018.3 Help

Global Settings

The page describes resources and methods that let you read and update the Global Settings of your YouTrack service.

Resource

/api/admin/globalSettings

Returned entity

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

Supported methods

Supported Fields

The returned entity contains the following attributes that you can require with the fields parameter of a request or provide in a request body.

For this particular entity, each of the fields is an object that represents a section of settings on the Global Settings page in the UI.

Field

Type

Description

appearanceSettings

AppearanceSettings

Stores service visual settings: the service logo, date and time presentation, and the server time zone.

license

License

Stores license information of the service.

limitations

Limitations

Stores license limitations for your service.

localeSettings

LocaleSettings

Stores system language settings.

notificationSettings

NotificationSettings

Stores global notification settings for your service: email, jabber, and notifications using REST API.

restSettings

RestCorsSettings

Settings for the REST API of the service: allowed origins.

shortcutSettings

ShortcutSettings

Stores settings of the current keyboard shortcuts scheme of your service.

systemSettings

SystemSettings

Stores system settings of your service: maximum size for attachments, maximum number of issues to export or maintain the custom order for, and so on.

updateInfo

UpdateInfo

Stores data about available system updates.

id

String

Stores unique ID of the entity.

Read Global Settings

Request syntax:

GET <YouTrack Service Base URL>/api/admin/globalSettings?[fields=<list of fields to return>]

<YouTrack Service Base URL>

The URL by which your YouTrack service is accessible.

[fields]

Comma-separated list of supported entity fields to return in the response. For details, see Fields Syntax.

Sample request:

curl -X GET \ 'https://example.myjetbrains.com/youtrack/api/admin/globalSettings?fields=appearanceSettings%28dateFieldFormat%28id,presentation%29,timeZone%28id,presentation%29%29,id,license%28freeUsername,id,isFreeLicenseUsed%29,localeSettings%28id,locale%28id,locale,name%29%29,restSettings%28allowAllOrigins,allowedOrigins,hubServiceOrigins,id%29,systemSettings%28allowStatisticsCollection,baseUrl,id,maxExportItems,maxOrderedIssues,maxUploadFileSize%29,updateInfo%28id,isChecking,result%28date,downloadUrl,id,message,success,updateAvailable%29%29' \ -H 'Accept: application/json' \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json'

Sample response body:

{ "license": { "freeUsername": "YouTrack Default", "isFreeLicenseUsed": true, "id": "40-0" }, "systemSettings": { "allowStatisticsCollection": true, "maxOrderedIssues": 500, "maxExportItems": 500, "maxUploadFileSize": 10485760, "baseUrl": "https://example.myjetbrains.com/youtrack", "id": "40-0" }, "localeSettings": { "locale": { "name": "English", "locale": "en_US", "id": "en_US" }, "id": "40-0" }, "updateInfo": { "result": { "success": true, "updateAvailable": false, "downloadUrl": null, "date": null, "message": "Update info is not available yet, check back later", "id": "update result" }, "isChecking": false, "id": "jetbrains.charisma.maintenance.checkUpdate.UpdateInfo" }, "appearanceSettings": { "dateFieldFormat": { "presentation": "Default date format (31 Dec 2000 23:59)" }, "timeZone": { "presentation": "Central European Summer Time (UTC/GMT +2 hours)", "id": "Europe/Berlin" } }, "restSettings": { "allowedOrigins": [], "allowAllOrigins": false, "hubServiceOrigins": [], "id": "jetbrains.charisma.persistent.globalSettings.RestCorsSettings" }, "id": "jetbrains.charisma.persistent.globalSettings.GlobalSettings" }

Update Global Settings

Request syntax:

POST <YouTrack Service Base URL>/api/admin/globalSettings?[fields=<list of fields to return>]

Request parameters:

<YouTrack Service Base URL>

The URL by which your YouTrack service is accessible.

[fields]

Comma-separated list of supported entity attributes to return in the response. For details, see Fields Syntax.

In the request body, provide entity attributes to update.

Sample request:

The following request sets the server time zone to "Europe/Berlin".

curl -X POST \ 'https://example.myjetbrains.com/youtrack/api/admin/globalSettings?fields=appearanceSettings%28dateFieldFormat%28id,presentation%29,timeZone%28id,presentation%29%29' \ -H 'Accept: application/json' \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json' \ -H 'Postman-Token: def93f8f-d400-4cf3-acbb-4eb7b6e8f360' \ -d '{"appearanceSettings": { "timeZone": { "id": "Europe/Berlin" } } }'

Sample response body:

{ "appearanceSettings": { "dateFieldFormat": { "presentation": "Default date format (31 Dec 2000 23:59)" }, "timeZone": { "presentation": "Central European Summer Time (UTC/GMT +2 hours)", "id": "Europe/Berlin" } } }
Last modified: 12 October 2018