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	`GET`: Read a Specific SystemSettings. `POST`: Update a Specific SystemSettings.

SystemSettings attributes

Represents the System settings that affect core functionality of YouTrack.

Related Resources

Below you can find the list of resources that let you work with this entity.

System Settings

Attributes

This table describes attributes of the SystemSettings entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The ID of the SystemSettings. `Read-only`.
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.

Required permissions

Requires permissions: Low-level Admin Read

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

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

Sample response body

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

Update a Specific SystemSettings

Change the System settings of your YouTrack service.

Required permissions

Requires permissions: Low-level Admin Write

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

                https://example.youtrack.cloud/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.youtrack.cloud",
                  "$type": "SystemSettings"
                }
            

Last modified: 7 November 2024