{
"opencollection": "1.0.0",
"info": {
"name": "Atlassian Admin Account App Properties API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"items": [
{
"info": {
"name": "App Properties",
"type": "folder"
},
"items": [
{
"info": {
"name": "Atlassian Get App Properties",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/atlassian-connect/1/addons/:addonKey/properties",
"params": [
{
"name": "addonKey",
"value": "",
"type": "path",
"description": "The key of the app, as defined in its descriptor."
}
]
},
"docs": "Gets all the properties of an app.
**[Permissions](#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`)."
},
{
"info": {
"name": "Atlassian Get App Property",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.atlassian.com/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey",
"params": [
{
"name": "addonKey",
"value": "",
"type": "path",
"description": "The key of the app, as defined in its descriptor."
},
{
"name": "propertyKey",
"value": "",
"type": "path",
"description": "The key of the property."
}
]
},
"docs": "Returns the key and value of an app's property.
**[Permissions](#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`)."
},
{
"info": {
"name": "Atlassian Set App Property",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey",
"params": [
{
"name": "addonKey",
"value": "",
"type": "path",
"description": "The key of the app, as defined in its descriptor."
},
{
"name": "propertyKey",
"value": "",
"type": "path",
"description": "The key of the property."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
**[Permissions](#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`)."
},
{
"info": {
"name": "Atlassian Delete App Property",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/atlassian-connect/1/addons/:addonKey/properties/:propertyKey",
"params": [
{
"name": "addonKey",
"value": "",
"type": "path",
"description": "The key of the app, as defined in its descriptor."
},
{
"name": "propertyKey",
"value": "",
"type": "path",
"description": "The key of the property."
}
]
},
"docs": "Deletes an app's property.
**[Permissions](#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`)."
},
{
"info": {
"name": "Atlassian Set App Property Forge",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.atlassian.com/rest/forge/1/app/properties/:propertyKey",
"params": [
{
"name": "propertyKey",
"value": "",
"type": "path",
"description": "The key of the property."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sets the value of a Forge app's property.
These values can be retrieved in [Jira expressions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/)
through the `app` [context variable](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#context-variables).
For other use cases, use the [Storage API](https://developer.atlassian.com/platform/forge/runtime-reference/storage-api/).
The value of the request body must be a [valid](http://tools.ietf"
},
{
"info": {
"name": "Atlassian Delete App Property Forge",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.atlassian.com/rest/forge/1/app/properties/:propertyKey",
"params": [
{
"name": "propertyKey",
"value": "",
"type": "path",
"description": "The key of the property."
}
]
},
"docs": "Deletes a Forge app's property.
**[Permissions](#permissions) required:** Only Forge apps can make this request."
}
]
}
],
"bundled": true
}