Set app property (Forge)

PUT

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

Sets the value of a Forge app's property.
These values can be retrieved in Jira expressions
through the app context variable.

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://jira.local:8080/jira/rest//rest/forge/1/app/properties/' \
--header 'Content-Type: application/json' \
--data-raw 'null'

Response Example

200 - Success

{
    "message": "Property updated.",
    "statusCode": 200
}

Request

Path Params

propertyKey

string

required

The key of the property.

Body Params application/json

No schema defined

Examples

Responses

🟢200Returned if the property is updated.

application/json

Body

message

string

required

The human-readable message that describes the result.

statusCode

integer

required

The status code of the response.

🟢201Returned is the property is created.

🟠400Returned if: * the property key is longer than 127 characters. * the value isn't valid JSON. * the value is longer than 32768 characters.

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

🟠403Returned if the request isn't made directly by an app or if it's an impersonated request.

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

Delete app property

Delete app property (Forge)