App properties

Get app property (Forge)

Returns the value of a Forge app's property.

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

get/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: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token)

Path parameters

propertyKeystring required

The key of the property.

Response

Returned if the request is successful.

keystring
valueunknown

Changes

No recorded changes to this operation across all 26 revisions of this API.