Confluence Cloud Developer

Confluence Cloud Developer

Rate this page:

Dynamic modules

Get modules

Experimental

GET /wiki/rest/atlassian-connect/1/app/module/dynamic

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

App scope requiredNONE

Request

There are no parameters for this request.

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/atlassian-connect/1/app/module/dynamic' \
  --header 'Accept: */*'

Responses

Returned if the request is successful.

Content typeValue
*/*

ConnectModules

Register modules

Experimental

POST /wiki/rest/atlassian-connect/1/app/module/dynamic

Registers a list of modules. For the list of modules that support dynamic registration, see Dynamic modules.

Permissions required: Only Connect apps can make this request.

App scope requiredNONE

Request

Body parameters

A list of app modules in the same format as the modules property in the app descriptor.

Additional Properties

Array<ConnectModule>

A list of modules by type.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
curl --request POST \
  --url 'https://your-domain.atlassian.net/wiki/rest/atlassian-connect/1/app/module/dynamic' \
  --header 'Content-Type: application/json' \
  --data '{
  "webItems": [
    {
      "key": "my-webitem",
      "location": "system.admin/globalsettings",
      "url": "/my-web-item",
      "name": {
        "value": "My Web Item"
      }
    }
  ],
  "adminPages": [
    {
      "key": "my-admin-page",
      "name": {
        "value": "My Admin Page"
      },
      "url": "/my-admin-page"
    }
  ]
}'

Responses

Returned if the request is successful.

A schema has not been defined for this response code.

Remove modules

Experimental

DELETE /wiki/rest/atlassian-connect/1/app/module/dynamic

Remove all or a list of modules registered by the calling app.

Permissions required: Only Connect apps can make this request.

App scope requiredNONE

Request

Query parameters
moduleKey Required

Array<string>

The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, moduleKey=dynamic-attachment-entity-property&moduleKey=dynamic-select-field. Nonexistent keys are ignored.

Example

1
2
curl --request DELETE \
  --url 'https://your-domain.atlassian.net/wiki/rest/atlassian-connect/1/app/module/dynamic?moduleKey={moduleKey}'

Responses

Returned if the request is successful.

Rate this page: