App properties

Set app property (Forge)

Changed on

Sets the value of a Forge app's property. These values can be retrieved in Jira expressions through the app context variable. They are also available in entity property display conditions.

For other use cases, use the Storage API.

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

Permissions required: Only Forge apps can make this request. This API can only be accessed using asApp() requests from Forge.

The new write:app-data:jira OAuth scope is 100% optional now, and not using it won't break your app. However, we recommend adding it to your app's scope list because we will eventually make it mandatory.

put/rest/forge/1/app/properties/{propertyKey}

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/forge/1/app/properties/{propertyKey}
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token

Path parameters

propertyKeystring required

The key of the property.

Request body

unknown required

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
}

Changes

  • 78da6ac152bcRevision changes
    • info

      api operation id AddonPropertiesResource.putAppProperty_put removed and replaced with putForgeAppProperty