• 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 states
  • Content versions
  • Content watches
  • Dynamic modules
  • Experimental
  • Group
  • Inline tasks
  • Label info
  • Long-running task
  • Relation
  • Settings
  • Space
  • Space permissions
  • Space properties
  • Space settings
  • Template
  • Themes
  • Users
  • User properties
Cloud
Confluence Cloud / Reference / REST API

Dynamic modules

Postman Collection
OpenAPI
GET

Get modulesExperimental

Returns all modules registered dynamically by the calling app.

Permissions required: Only Connect apps can make this request.

Data Security Policy: Exempt from app access rules
Scopes

Connect apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returned if the request is successful.

*/*

ConnectModules
GET/atlassian-connect/1/app/module/dynamic
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());
POST

Register modulesExperimental

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.

Data Security Policy: Exempt from app access rules
Scopes

Connect apps cannot access this REST resource.

Request

Request body*/*

modules

array<ConnectModule>

Required

Responses

Returned if the request is successful.

POST/atlassian-connect/1/app/module/dynamic
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());
DEL

Remove modulesExperimental

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

Permissions required: Only Connect apps can make this request.

Data Security Policy: Exempt from app access rules
Scopes

Connect apps cannot access this REST resource.

Request

Query parameters

moduleKey

array<string>

Required

Responses

Returned if the request is successful.

DEL/atlassian-connect/1/app/module/dynamic
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());

Rate this page: