Developer
News and Updates
Get Support
Sign in
Developer
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
News and Updates
Get support
Sign in
Developer
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
News and Updates
Get support
Sign in
  • App Installations
  • Atlassian GraphQL
  • Confluence
  • Forge Context
  • Forge Dynamic Modules
  • Forge Events
  • Forge KVS
  • Forge LLM
  • Forge Object Store
  • Forge Proxy
  • Forge Realtime
  • Forge SQL
  • Jira
Platform
Forge / Reference / APIs for Forge Containers

Forge Dynamic Modules

Postman Collection
OpenAPI

Forge Dynamic Modules API for managing dynamic modules

Operations
GET/atlassian/forge/installation/v1/dynamic/modulePUT/atlassian/forge/installation/v1/dynamic/modulePOST/atlassian/forge/installation/v1/dynamic/moduleGET/atlassian/forge/installation/v1/dynamic/module/{key}DEL/atlassian/forge/installation/v1/dynamic/module/{key}
GET

List all dynamic modules

Request

Query parameters

nextPageToken

string

limit

integer

Header parameters

forge-proxy-authorization

string

Required

Responses

List of dynamic modules

application/json

object
GET/atlassian/forge/installation/v1/dynamic/module
1 2 3 4 curl --request GET \ --url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v1/dynamic/module' \ --header 'Accept: application/json' \ --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'
200Response
1 2 3 4 5 6 7 8 9 10 { "result": [ { "key": "<string>", "type": "<string>", "data": {} } ], "lastEvaluatedKey": "<string>" }
PUT

Update a dynamic module

Request

Header parameters

forge-proxy-authorization

string

Required

Request bodyapplication/json

key

string

Required
type

string

Required
data

object

Required

Responses

Dynamic module updated successfully

application/json

DynamicModule
PUT/atlassian/forge/installation/v1/dynamic/module
1 2 3 4 5 6 7 8 9 10 curl --request PUT \ --url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v1/dynamic/module' \ --header 'Accept: application/json' \ --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \ --header 'Content-Type: application/json' \ --data '{ "key": "<string>", "type": "<string>", "data": {} }'
200Response
1 2 3 4 5 { "key": "<string>", "type": "<string>", "data": {} }
POST

Create a dynamic module

Request

Header parameters

forge-proxy-authorization

string

Required

Request bodyapplication/json

key

string

Required
type

string

Required
data

object

Required

Responses

Dynamic module created successfully

application/json

DynamicModule
POST/atlassian/forge/installation/v1/dynamic/module
1 2 3 4 5 6 7 8 9 10 curl --request POST \ --url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v1/dynamic/module' \ --header 'Accept: application/json' \ --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \ --header 'Content-Type: application/json' \ --data '{ "key": "<string>", "type": "<string>", "data": {} }'
201Response
1 2 3 4 5 { "key": "<string>", "type": "<string>", "data": {} }
GET

Get a dynamic module

Request

Path parameters

key

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Dynamic module retrieved successfully

application/json

DynamicModule
GET/atlassian/forge/installation/v1/dynamic/module/{key}
1 2 3 4 curl --request GET \ --url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v1/dynamic/module/{key}' \ --header 'Accept: application/json' \ --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'
200Response
1 2 3 4 5 { "key": "<string>", "type": "<string>", "data": {} }
DEL

Delete a dynamic module

Request

Path parameters

key

string

Required

Header parameters

forge-proxy-authorization

string

Required

Responses

Dynamic module deleted successfully

DEL/atlassian/forge/installation/v1/dynamic/module/{key}
1 2 3 curl --request DELETE \ --url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v1/dynamic/module/{key}' \ --header 'forge-proxy-authorization: Forge as=app,id=invocation-123'

Rate this page: