Set app property

PUT

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

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.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Success

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

Request

Path Params

addonKey

string

required

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

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 is not valid JSON. * the value is longer than 32768 characters.

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

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

Get app property

Delete app property