GET .../addons/{addonKey}

Returns a representation of the add-on with the given key, including the state and license of the add-on.

Parameters:

LocationNameTypeDescription
PathaddonKeystring

The key of the add-on, as defined in its descriptor

 

Response fields:

The fields key and version correspond to fields with the same name in the the add-on descriptor.

NameTypeDescription
statestring

The state of the add-on, ENABLED or DISABLED.

host.productstring

The display name of the host product, JIRAor Confluence.

host.contacts.namestring

The name of a contact person for the host instance.

host.contacts.emailstring

The e-mail of a contact person for the host instance.

license.activeboolean

The state of the license, true for active subscriptions and evaluations, false for terminated subscriptions and expired evaluations.

license.typestring

The license type, see FAQ. Possible values include, but are not limited to COMMERCIAL,COMMUNITYACADEMIC and DEVELOPER.

license.evaluationboolean

A flag indicating whether the add-on is being used under an evaluation license.

license.supportEntitlementNumber(optional)string

The Support Entitlement Number (SEN) associated with the license. This attribute will be included for a licensed (paid) add-on.

Response representations:

200 - application/json

Request issued by enabled, licensed add-on.

{
   "key": "example-addon",
   "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-addon"
         }
      ],
      "self": [
         {
            "href": "http:// example.com/rest/atlassian-connect/latest/example-addon"
         }
      ]
   }
}
200 - application/json

Request issued by enabled, unlicensed add-on.

{
   "key": "example-addon",
   "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-addon"
         }
      ],
      "self": [
         {
            "href": "http:// example.com/rest/atlassian-connect/latest/example-addon"
         }
      ]
   }
}
200 - application/json

Request issued by disabled add-on.

{
   "key": "example-addon",
   "version": "1.0",
   "state": "DISABLED"
}
401 - application/json

Request without credentials or with invalid credentials.
Note that this specific resource accepts also requests from disabled add-ons.

403 - application/json

Request issued by an add-on to the resource related with a different add-on.