How to retrieve application license details or set the license via private REST API in Jira 7+
Platform Notice: Data Center - This article applies to Atlassian products on the Data Center platform.
Note that this knowledge base article was created for the Data Center version of the product. Data Center knowledge base articles for non-Data Center-specific features may also work for Server versions of the product, however they have not been tested. Support for Server* products ended on February 15th 2024. If you are running a Server product, you can visit the Atlassian Server end of support announcement to review your migration options.
*Except Fisheye and Crucible
Purpose
This document is for System Administrators who would like to use the private REST API to:
- either retrieve their application license details
- or update/set the application license key
Please note that these are private endpoints and may change without notice. Please refer to JRASERVER-65774 - Retrieve application license details or update license via public REST API for an official public endpoint.
Solution to retrieve the license details:
The following endpoints will return the license details for the respective application
Jira Software
/rest/plugins/applications/1.0/installed/jira-software/licenseJira Service Management
/rest/plugins/applications/1.0/installed/jira-servicedesk/licenseJira Core
/rest/plugins/applications/1.0/installed/jira-core/license
Here is an example response:
{
"valid": true,
"evaluation": false,
"maximumNumberOfUsers": 10000,
"licenseType": "Commercial",
"creationDateString": "07/Dec/15",
"expiryDate": 4100331600000,
"expiryDateString": "07/Dec/17",
"organizationName": "Atlassian",
"dataCenter": false,
"subscription": false,
"rawLicense": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"maintenanceExpired": false,
"enterprise": false,
"active": true,
"autoRenewal": false
}
As an additional information, you can use api/2/applicationrole to identify number of used/remaining licenses in the application. More information here: GET /rest/api/2/applicationrole/{key}
Solution to set the license:
To set the license details, you will need to use the following API call using:
- the POST method
the following body where <LICENSE_KEY> needs to be replaced with the license key of the application you are trying set the license for
{"licenseKey": "<LICENSE_KEY>"}
- the following endpoints for the respective application:
Jira Software
/rest/plugins/applications/1.0/installed/jira-software/licenseJira Service Management
/rest/plugins/applications/1.0/installed/jira-servicedesk/licenseJira Core
/rest/plugins/applications/1.0/installed/jira-core/license
An example of how the cURL command would look like to set the value for jira-software (replace admin username, password, JIRA_BASE_URL and the actual license):
curl -v -u adminusername:adminpassword -X POST <JIRA_BASE_URL>/rest/plugins/applications/1.0/installed/jira-software/license/ -H "Content-Type: application/vnd.atl.plugins+json" -d '{"licenseKey":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}'If not familiar with REST API, you can refer to the following documentation:
For add-ons, you can refer to the following article instead: