This resource represents license metrics. Use it to get available metrics for Jira licences.
Returns licensing information about the Jira instance.
Permissions required: None.
Connect app scope required: READ
manage:jira-configurationread:license:jiraThis request has no parameters.
Returned if the request is successful.
Details about a license for the Jira instance.
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/instance/license`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"applications": [
{
"id": "jira-core",
"plan": "PAID"
},
{
"id": "jira-servicedesk",
"plan": "FREE"
},
{
"id": "jira-software",
"plan": "PAID"
},
{
"id": "jira-product-discovery",
"plan": "FREE"
}
]
}Returns the approximate number of user accounts across all Jira licenses. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.
Permissions required: Administer Jira global permission.
Connect app scope required: READ
manage:jira-configurationread:license:jiraThis request has no parameters.
Returned if the request is successful.
A metric that provides insight into the active licence details
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/license/approximateLicenseCount`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
{
"key": "license.totalApproximateUserCount",
"value": "1000"
}Returns the total approximate number of user accounts for a single Jira license. Note that this information is cached with a 7-day lifecycle and could be stale at the time of call.
Permissions required: Administer Jira global permission.
Connect app scope required: READ
manage:jira-configurationread:license:jirastring
RequiredReturned if the request is successful.
A metric that provides insight into the active licence details
1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";
const response = await api.asUser().requestJira(route`/rest/api/2/license/approximateLicenseCount/product/{applicationKey}`, {
headers: {
'Accept': 'application/json'
}
});
console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());1
2
3
4
{
"key": "license.jira-software.approximateUserCount",
"value": "115"
}Rate this page: