APIs for managing app software data and operations.
Get mapping of app software id with the corresponding hosting type for the specified app.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
array<string>
Successfully retrieved app software information
array<AppSoftwareByAppKeyResponse>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/app-key/{appKey}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"appSoftwareId": "acd011b1-1111-45bc-902a-247046a11111",
"hosting": "cloud",
"complianceBoundaries": [
"commercial"
]
},
{
"appSoftwareId": "bde122c2-2222-56cd-a13b-358157b22222",
"hosting": "server",
"complianceBoundaries": null
}
]Get a list of versions of the specified app software.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
string
string
integer
string
string
string
Successfully retrieved app software versions
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
"links": {
"self": "/rest/3/app-software/bde122c2-2222-56cd-a13b-358157b22222/versions",
"next": "/rest/3/app-software/bde122c2-2222-56cd-a13b-358157b22222/versions?cursor=nextPageToken"
},
"versions": [
{
"buildNumber": 1001,
"versionNumber": "1.0.1",
"compatibilities": [
{
"parentSoftwareId": "jira",
"minBuildNumber": 80000,
"maxBuildNumber": 90000
}
],
"supportedPaymentModel": "free",
"frameworkDetails": {
"frameworkId": "connect",
"attributes": {
"descriptorId": "descriptor-123",
"scopes": [
"READ",
"WRITE"
],
"descriptorUrl": "https://example.com/descriptor"
}
},
"supported": true,
"beta": false,
"state": "active",
"revision": 1,
"createdBy": "developer@example.com",
"createdAt": "2023-01-15T10:30:00Z",
"changelog": {
"releaseSummary": "Bug fixes and performance improvements",
"releaseNotes": "This version includes several bug fixes and performance optimizations"
}
}
],
"totalCount": 1
}Creates a new version of the specified app software.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
string
array<AppSoftwareVersionCompatibility>
Requiredstring
RequiredAppSoftwareVersionFrameworkDetails
RequiredAppSoftwareVersionLicenseType
SourceCodeLicense
AppSoftwareVersionChangelog
boolean
Requiredboolean
RequiredApp software version created successfully
string
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
curl --request POST \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"buildNumber": 1001,
"versionNumber": "1.0.1",
"compatibilities": [
{
"parentSoftwareId": "jira",
"minBuildNumber": 80000,
"maxBuildNumber": 90000
}
],
"supportedPaymentModel": "free",
"frameworkDetails": {
"frameworkId": "connect",
"attributes": {
"descriptorId": "descriptor-123",
"scopes": [
"READ",
"WRITE"
]
}
},
"licenseType": {
"id": "commercial"
},
"supported": true,
"beta": false,
"acceptedAgreements": [
{
"agreementUrl": "https://developer.atlassian.com/marketplace/terms"
}
],
"changelog": {
"releaseSummary": "Bug fixes and performance improvements",
"releaseNotes": "This version includes several bug fixes and performance optimizations"
}
}'Get the specified version of the specified app software by the version's build number
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
RequiredSuccessfully retrieved app software version
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions/{buildNumber}' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
"buildNumber": 1001,
"versionNumber": "1.0.1",
"compatibilities": [
{
"parentSoftwareId": "jira",
"minBuildNumber": 80000,
"maxBuildNumber": 90000
}
],
"supportedPaymentModel": "free",
"frameworkDetails": {
"frameworkId": "connect",
"attributes": {
"descriptorId": "descriptor-123",
"scopes": [
"READ",
"WRITE"
],
"descriptorUrl": "https://example.com/descriptor"
}
},
"licenseType": {
"id": "commercial",
"name": "Commercial License",
"link": "https://example.com/license"
},
"supported": true,
"beta": false,
"state": "active",
"revision": 1,
"createdBy": "developer@example.com",
"createdAt": "2023-01-15T10:30:00Z",
"changelog": {
"releaseSummary": "Bug fixes and performance improvements",
"releaseNotes": "This version includes several bug fixes and performance optimizations"
}
}Update a specific version of the app’s software.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredinteger
Requiredinteger
Requiredstring
Requiredarray<AppSoftwareVersionCompatibility>
Requiredstring
RequiredAppSoftwareVersionFrameworkDetails
RequiredAppSoftwareVersionLicenseType
SourceCodeLicense
AppSoftwareVersionChangelog
boolean
Requiredboolean
RequiredApp software version updated successfully
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
curl --request PUT \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{appSoftwareId}/versions/{buildNumber}' \
--user 'email@example.com:<api_token>' \
--header 'Content-Type: application/json' \
--data '{
"buildNumber": 1001,
"versionNumber": "1.0.2",
"compatibilities": [
{
"parentSoftwareId": "jira",
"minBuildNumber": 80000,
"maxBuildNumber": 95000
}
],
"supportedPaymentModel": "free",
"frameworkDetails": {
"frameworkId": "connect",
"attributes": {
"descriptorId": "descriptor-123",
"scopes": [
"READ",
"WRITE",
"DELETE"
]
}
},
"licenseType": {
"id": "commercial"
},
"supported": true,
"beta": false,
"state": "active",
"revision": 2,
"acceptedAgreements": [
{
"agreementUrl": "https://developer.atlassian.com/marketplace/terms"
}
],
"changelog": {
"releaseSummary": "Updated version with additional fixes",
"releaseNotes": "Added new features and fixed critical bugs"
}
}'Get list of access tokens associated with a specified app software.
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Successfully retrieved access tokens
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{id}/tokens' \
--user 'email@example.com:<api_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
"tokens": [
{
"token": "at_abc123xyz789",
"cloudId": "cloud-123",
"instance": "instance-456"
},
{
"token": "at_def456uvw012",
"cloudId": "cloud-456",
"instance": null
}
]
}Creates a new access token for the specified app software.
Forge and OAuth2 apps cannot access this REST resource.
string
RequiredAccess token created successfully
string
1
2
3
curl --request POST \
--url 'https://api.atlassian.com/marketplace/rest/3/app-software/{id}/tokens' \
--user 'email@example.com:<api_token>'Rate this page: