Developer Portal for YouTrack and Hub Help

Operations with Specific License

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

Resource

/api/admin/globalSettings/license

Returned entity

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

Supported methods

License attributes

Represents the current license of the YouTrack service.

Related Resources

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

Attributes

This table describes attributes of the License 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 license. Read-only.

username

String

Username used for license. Can be null.

license

String

License key. Can be null.

error

String

License error. If there is no error, this property is empty. Read-only. Can be null.

Read a Specific License

Read the license of your YouTrack service.

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of License 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/license?fields=username,license,error

Sample response body

{ "username": "example", "license": "17269e7714ee93dec5002a17427b55f3126a37635d9a41349ffb02dfc0b1bd7b167dcb56232813da571653c087bb2e1ff9325e4775d494c2f99eab72100d1e90cf7532d8f4e721b27521d107fb3f62", "error": null, "$type": "License" }

Update a Specific License

Change the license of your YouTrack service.

Required permissions

Requires permissions: Low-level Admin Write

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of License 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/license?fields=username,license,error

Sample request body

{ "username": "sample", "license": "17269e7714ee93dec5002a17427b55f3126a37635d9a49325e4775d494c2f99eab72100d1e90cf7532d8f4e721b27521d107fb3f62" }

Sample response body

{ "username": "sample", "license": "17269e7714ee93dec5002a17427b55f3126a37635d9a49325e4775d494c2f99eab72100d1e90cf7532d8f4e721b27521d107fb3f62", "error": null, "$type": "License" }
Last modified: 19 September 2024