Get app property

GET

/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}

Returns the key and value of an app's property.

Permissions required: Only a Connect app whose key matches addonKey can make this request.
Additionally, Forge apps published on the Marketplace can access properties of Connect apps they were migrated from.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/atlassian-connect/1/addons//properties/'

Response Example

200 - Success

{
    "self": "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey",
    "key": "propertyKey",
    "value": "propertyValue"
}

Request

Path Params

addonKey

string

required

The key of the app, as defined in its descriptor.

propertyKey

string

required

The key of the property.

Responses

🟢200Returned if the request is successful.

application/json

Body

An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).

key

string

optional

The key of the property. Required on create and update.

value

optional

The value of the property. Required on create and update.

🟠400Returned if the property key is longer than 127 characters.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the property is not found or doesn't belong to the app.

Modified at 2023-07-13 03:27:27

Get app properties

Set app property