Documentation
REST APIs
Atlassian products have a rich set of REST APIs for you to use. These APIs are the way that you interact with the Atlassian application's features and data.
API Structure
Atlassian's REST APIs follow an established structure. Note that the context-path element is not always used.
https://myhost.com:port/context-path/rest/api-name/api-version/resource-nameProduct APIs
Atlassian REST API Browser provides an interactive interface to help you get acquainted with the available APIs. Additionally, there is static REST API documentation available for JIRA and Confluence.
Atlassian Connect
Atlassian Connect provides a set of REST APIs specifically designed for use by add-ons. The api-name used is atlassian-connect.
Index
/rest/atlassian-connect/1/addons/{addonKey}[GET]/rest/atlassian-connect/1/addons/{addonKey}/properties[GET]/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}[GET,PUT,DELETE]
Resources
GET.../addons/{addonKey}Returns a representation of the add-on with the given key, including the state and license of the add-on.
Parameters:
Location Name Type Description Path addonKeystringThe key of the add-on, as defined in its descriptor
Response fields:
The fields
keyandversioncorrespond to fields with the same name in the the add-on descriptor.Name Type Description statestringThe state of the add-on,
ENABLEDorDISABLED.host.productstringThe display name of the host product,
JIRAorConfluence.host.contacts.namestringThe name of a contact person for the host instance.
host.contacts.emailstringThe e-mail of a contact person for the host instance.
license.activebooleanThe state of the license,
truefor active subscriptions and evaluations,falsefor terminated subscriptions and expired evaluations.license.typestringThe license type, see FAQ. Possible values include, but are not limited to
COMMERCIAL,COMMUNITY,ACADEMICandDEVELOPER.license.evaluationbooleanA flag indicating whether the add-on is being used under an evaluation license.
license.supportEntitlementNumber(optional)stringThe Support Entitlement Number (SEN) associated with the license. This attribute will be included for a licensed (paid) add-on.
Response representations:
200- application/jsonRequest issued by enabled, licensed add-on.
200- application/jsonRequest issued by enabled, unlicensed add-on.
200- application/jsonRequest issued by disabled add-on.
401- application/jsonRequest without credentials or with invalid credentials, e.g. by an uninstalled add-on.
403- application/jsonRequest issued by a user with insufficient credentials, e.g. for an add-on's data by anyone but the add-on itself.
GET.../addons/{addonKey}/propertiesReturns a list of property keys for the given add-on key.
Parameters:
Location Name Type Description Path addonKeystringThe key of the add-on, as defined in its descriptor
Response representations:
200- application/json401- application/jsonRequest without credentials or with invalid credentials, e.g. by an uninstalled add-on.
404- application/jsonRequest issued by a user with insufficient credentials, e.g. for an add-on's data by anyone but the add-on itself, or for a plugin that does not exist.
GET.../addons/{addonKey}/properties/{propertyKey}Returns a property for the given property key.
Parameters:
Location Name Type Description Path addonKeystringThe key of the add-on, as defined in its descriptor
Path propertyKeystringThe key of the property
Response representations:
200- application/json400- application/jsonProperty key longer than 127 characters.
401- application/jsonRequest without credentials or with invalid credentials, e.g. by an uninstalled add-on.
404- application/jsonRequest to get a property that does not exist.
404- application/jsonRequest issued by a user with insufficient credentials, e.g. for an add-on's data by anyone but the add-on itself, or for a plugin that does not exist.
PUT.../addons/{addonKey}/properties/{propertyKey}Creates or updates a property.
Parameters:
Location Name Type Description Path addonKeystringThe key of the add-on, as defined in its descriptor
Path propertyKeystringThe key of the property
Response representations:
200- application/jsonProperty updated.
201- application/jsonProperty created.
400- application/jsonProperty key longer than 127 characters.
400- application/jsonRequest made with invalid JSON.
401- application/jsonRequest without credentials or with invalid credentials, e.g. by an uninstalled add-on.
404- application/jsonRequest to get a property that does not exist.
404- application/jsonRequest issued by a user with insufficient credentials, e.g. for an add-on's data by anyone but the add-on itself, or for a plugin that does not exist.
DELETE.../addons/{addonKey}/properties/{propertyKey}Deletes a property.
Parameters:
Location Name Type Description Path addonKeystringThe key of the add-on, as defined in its descriptor
Path propertyKeystringThe key of the property
Response representations:
204- application/jsonProperty deleted.
400- application/jsonProperty key longer than 127 characters.
401- application/jsonRequest without credentials or with invalid credentials, e.g. by an uninstalled add-on.
404- application/jsonRequest to get a property that does not exist.
404- application/jsonRequest issued by a user with insufficient credentials, e.g. for an add-on's data by anyone but the add-on itself, or for a plugin that does not exist.
