v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB

App properties

Get app property

Returns the key and value of an app's property. The property key connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8 is reserved. It returns a synthetic, read-only property containing the Connect clientKey for the requested tenant. This is intended for Forge apps with app.connect.key to retrieve the Connect client key during migration.

Permissions required: Only a Connect app whose key matches addonKey can make this request. Additionally, Forge apps can access Connect app properties (stored against the same app.connect.key).

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

Path parameters

addonKeystring required

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

propertyKeystring required

The key of the property.

Response

Returned if the request is successful.

keystring

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

{"stackTrail":"components:schemas:EntityProperty:properties:value","oasType":"schema","type":"unknown","description":"The value of the property. Required on create and update."}