The property key connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8 is reserved. It returns a synthetic, read-only property containing the Connect clientKey for the requested tenant. This is intended for Forge apps with app.connect.key to retrieve the Connect client key during migration. Attempts to create, update, or delete this key will return 403 Forbidden. This key does not appear in the list returned by Get app property keys.

Get app property keys

GET /wiki/rest/atlassian-connect/1/addons/{addonKey}/properties

Returns a list of property keys for the given app key.

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).

Scopes

Connect app scope required: NONE

OAuth 2.0 scope required: read:app-data:confluence

Parameters

Location	Name	Type	Description
Path	`addonKey`	`string`	The key of the app, as defined in its descriptor

Response representations

`200` - application/json

1
2
{
  "keys" : [
        {
          "key" : "first_key",
          "self" : "https://your-site.atlassian.net/wiki/rest/atlassian-connect/1/addons/my-add-on/properties/first_key"
        },
        {
          "key" : "another_key",
          "self" : "https://your-site.atlassian.net/wiki/rest/atlassian-connect/1/addons/my-add-on/properties/another_key"
        }
  ]
}

`401` - application/json

Request without credentials or with invalid credentials, e.g., by an uninstalled app.

`404` - application/json

Request issued by a user with insufficient credentials, e.g., for an app's data by anyone but the app itself, or for a app that does not exist.

Get app property

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

Returns an app property for the given property key. The reserved property key connect_client_key_019cdff3-8bfb-71fe-9628-875b700aebb8 will return a read-only property containing the Connect clientKey for the requested tenant.

Scopes

Connect app scope required: NONE

OAuth 2.0 scope required: read:app-data:confluence

Parameters

Location	Name	Type	Description
Path	`addonKey`	`string`	The key of the app, as defined in its descriptor
Path	`propertyKey`	`string`	The key of the property
Query	`jsonValue`	`boolean`	Set to `true` to have the `value` field return as a JSON object. If false it will return the `value` field as a string containing escaped JSON. This will be deprecated during June 2016 and the behavior will default to true.

Response representations

`200` - application/json

1
2
{
  "key" : "abcd",
  "value" : true,
  "self" : "https://your-site.atlassian.net/wiki/rest/atlassian-connect/1/addons/my-add-on/properties/abcd"
}

`400` - application/json

Property key longer than 127 characters.

`401` - application/json

Request without credentials or with invalid credentials, e.g., by an uninstalled app.

`404` - application/json

Request to get a property that does not exist.

`404` - application/json

Request issued by a user with insufficient credentials, e.g., for an app's data by anyone but the app itself, or for a app that does not exist.

Create or update app property

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

Creates or updates a property.

Scopes

Connect app scope required: NONE

OAuth 2.0 scope required: write:app-data:confluence

Parameters

Location	Name	Type	Description
Path	`addonKey`	`string`	The key of the app, as defined in its descriptor
Path	`propertyKey`	`string`	The key of the property

Response

`200` - application/json

Property updated.

`201` - application/json

Property created.

`400` - application/json

Property key longer than 127 characters.

`400` - application/json

Request made with invalid JSON.

`401` - application/json

Request without credentials or with invalid credentials, e.g., by an uninstalled app.

`403` - application/json

The property key is reserved and read-only. It cannot be created or updated.

`404` - application/json

Request to get a property that does not exist.

`404` - application/json

Request issued by a user with insufficient credentials, e.g., for an app's data by anyone but the app itself, or for a app that does not exist.

Delete app property

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

Deletes an app property.

Scopes

Connect app scope required: NONE

OAuth 2.0 scope required: write:app-data:confluence

Parameters

Location	Name	Type	Description
Path	`addonKey`	`string`	The key of the app, as defined in its descriptor
Path	`propertyKey`	`string`	The key of the property

Response representations

`204` - application/json

Property deleted.

`400` - application/json

Property key longer than 127 characters.

`401` - application/json

Request without credentials or with invalid credentials, e.g., by an uninstalled app.

`403` - application/json

The property key is reserved and read-only. It cannot be deleted.

`404` - application/json

Request to get a property that does not exist.

`404` - application/json

Request issued by a user with insufficient credentials, e.g., for an app's data by anyone but the app itself, or for a app that does not exist.