v4

latestOpenAPI 3.0.1Apache 2.02026-08-016079122.3 MB
App properties

Set app property

Sets the value of an app's property. Use this resource to store custom data for your app.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

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).

put/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.

Request body

{"stackTrail":"paths:/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}:put:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

Returned if the property is updated.

messagestring required

The human-readable message that describes the result.

statusCodeinteger required

The status code of the response.

Example response

{
  "message": "An example message.",
  "statusCode": 200
}