Forge Dynamic Modules API for managing dynamic modules
string
integer
string
RequiredList of dynamic modules
1
2
3
4
curl --request GET \
--url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v2/dynamic/module' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123'1
2
3
4
5
6
7
8
9
10
{
"result": [
{
"key": "<string>",
"type": "<string>",
"data": {}
}
],
"lastEvaluatedKey": "<string>"
}Updates an existing dynamic module. The key in the URL path is authoritative; the request body does not include key.
string
Requiredstring
Requiredobject
RequiredDynamic module updated successfully
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v2/dynamic/module' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"type": "<string>",
"data": {}
}'1
2
3
4
5
{
"key": "<string>",
"type": "<string>",
"data": {}
}Creates a dynamic module. The module key is generated server-side as a UUID v4 and returned in the response.
string
Requiredstring
Requiredobject
RequiredDynamic module created successfully
1
2
3
4
5
6
7
8
9
curl --request POST \
--url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v2/dynamic/module' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
--header 'Content-Type: application/json' \
--data '{
"type": "<string>",
"data": {}
}'1
2
3
4
5
{
"key": "<string>",
"type": "<string>",
"data": {}
}string
Requiredstring
RequiredDynamic module retrieved successfully
1
2
3
4
curl --request GET \
--url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v2/dynamic/module/{key}' \
--header 'Accept: application/json' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123'1
2
3
4
5
{
"key": "<string>",
"type": "<string>",
"data": {}
}string
Requiredstring
RequiredDynamic module deleted successfully
1
2
3
curl --request DELETE \
--url '{FORGE_EGRESS_PROXY_URL}/atlassian/forge/installation/v2/dynamic/module/{key}' \
--header 'forge-proxy-authorization: Forge as=app,id=invocation-123'Rate this page: