License API for cloud apps

Atlassian Connect provides a set of REST APIs specifically designed for use by cloud apps. Requests to these resources are made against the Jira or Confluence Cloud instance, not the Marketplace API.

Note that Jira and Confluence have separate URIs for these resources.

GET /rest/atlassian-connect/1/addons/{appKey}

Returns a representation of the Jira app with the given key.

GET /wiki/rest/atlassian-connect/1/addons/{appKey}

Returns a representation of the Confluence app with the given key.

Parameters

Location	Name	Type	Description
Path	`appKey`	`string`	The `key` of the app, as defined in its descriptor.

Response fields

Name	Type	Description
`key`	`string`	The `key` of the app, as defined in its descriptor.
`version`	`string`	The `version` of the app, as defined in its descriptor.
`state`	`string`	The state of the app. `ENABLED` is the only value returned.
`host.product`	`string`	The display name of the host product, `Jira` or `Confluence`.
`host.contacts.name`	`string`	The name of a contact person for the host instance.
`host.contacts.email`	`string`	The e-mail of a contact person for the host instance.
`license.active` (included for paid apps only)	`boolean`	The state of the license: `true` for active subscriptions and evaluations, `false` for terminated subscriptions and expired evaluations.
`license.type` (included for paid apps only)	`string`	The license type (see FAQ). Possible values include, but are not limited to `COMMERCIAL`, `COMMUNITY`, `ACADEMIC` and `DEVELOPER`.
`license.evaluation` (included for paid apps only)	`boolean`	A flag indicating whether the app is being used under an evaluation license.
`license.supportEntitlementNumber` (included for paid apps only)	`string`	The Support Entitlement Number (SEN) identifying the license. Note: this value is deprecated and will be removed.
`license.entitlementId` (included for paid apps only)	`string`	The license entitlement identifier.
`license.entitlementNumber` (included for paid apps only)	`string`	The license entitlement number.

Response representations

`200` - application/json

Request issued by licensed app.

1
2
{
  "key": "example-app",
  "version": "1.0",
  "state": "ENABLED",
  "host": {
      "product": "Jira",
      "contacts": [
        {
            "name": "Example Contact",
            "email": "contact@example.com"
        }
      ]
  },
  "license": {
      "active": true,
      "type": "COMMERCIAL",
      "evaluation": false,
      "supportEntitlementNumber": "SEN-###"
  },
  "links": {
      "marketplace": [
        {
            "href": "http:// marketplace.atlassian.com/plugins/example-app"
        }
      ],
      "self": [
        {
            "href": "http:// example.com/rest/atlassian-connect/latest/example-app"
        }
      ]
  }
}

`200` - application/json

Request issued by unlicensed app.

1
2
{
    "key": "example-app",
    "version": "1.0",
    "state": "ENABLED",
    "host": {
        "product": "Jira",
        "contacts": [
          {
              "name": "Example Contact",
              "email": "contact@example.com"
          }
        ]
    },
    "links": {
        "marketplace": [
          {
              "href": "http:// marketplace.atlassian.com/plugins/example-app"
          }
        ],
        "self": [
          {
              "href": "http:// example.com/rest/atlassian-connect/latest/example-app"
          }
        ]
    }
}

`401` - application/json

Request without credentials or with invalid credentials.

`403` - application/json

Request issued by an app to the resource related with a different app.