Audit
Analytics
Content
Content - attachments
Content body
Content - children and descendants
Content - macro body
Content comments
Content labels
Content permissions
Content properties
Content restrictions
Content versions
Content watches
Dynamic modules
Experimental
Group
Inline tasks
Label info
Long-running task
Relation
Search
Settings
Space
Space permissions
Space properties
Space settings
Template
Themes
Users

Rate this page:

Dynamic modules

Get modules

Experimental

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

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

Connect apps cannot access this REST resource.

OAuth scopes required
NONE

Request

There are no parameters for this request.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/confluence/rest/#auth
import api, { route } from "@forge/api";

const response = await api.requestConfluence(route`/atlassian-connect/1/app/module/dynamic`, {
  headers: {
    'Accept': '*/*'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Returned if the request is successful.

Content typeValue
*/*

ConnectModules

Register modules

Experimental

POST /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.

Connect apps cannot access this REST resource.

OAuth scopes required
NONE

Request

Body parameters
Content typeValue
*/*

ConnectModules

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/confluence/rest/#auth
import api, { route } from "@forge/api";

const response = await api.requestConfluence(route`/atlassian-connect/1/app/module/dynamic`, {
  method: 'POST'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Returned if the request is successful.

A schema has not been defined for this response code.

Remove modules

Experimental

DELETE /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.

Connect apps cannot access this REST resource.

OAuth scopes required
NONE

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.

Style: form

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/confluence/rest/#auth
import api, { route } from "@forge/api";

const response = await api.requestConfluence(route`/atlassian-connect/1/app/module/dynamic?moduleKey={moduleKey}`, {
  method: 'DELETE'
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.text());

Responses

Returned if the request is successful.

A schema has not been defined for this response code.

Rate this page: