• Announcement banner
  • App data policies (EAP)
  • Application roles
  • Audit records
  • Avatars
  • Classification levels
  • Dashboards
  • Filters
  • Filter sharing
  • Group and user picker
  • Groups
  • Issues
  • UI modifications (apps)
  • Issue attachments
  • Issue comments
  • Issue comment properties
  • Issue fields
  • Issue field configurations
  • Issue custom field contexts
  • Issue custom field options
  • Issue custom field options (apps)
  • Issue custom field values (apps)
  • Issue custom field configuration (apps)
  • Issue navigator settings
  • Issue notification schemes
  • Issue priorities
  • Issue properties
  • Issue resolutions
  • Issue security level
  • Issue security schemes
  • Issue types
  • Issue type schemes
  • Issue type screen schemes
  • Issue type properties
  • Issue votes
  • Issue watchers
  • Issue worklogs
  • Issue worklog properties
  • Jira expressions
  • Jira settings
  • JQL
  • JQL functions (apps)
  • Labels
  • License metrics
  • Myself
  • Permissions
  • Permission schemes
  • Projects
  • Project avatars
  • Project categories
  • Project classification levels
  • Project components
  • Project email
  • Project features
  • Project key and name validation
  • Project permission schemes
  • Project properties
  • Project roles
  • Project role actors
  • Project types
  • Project versions
  • Screens
  • Screen tabs
  • Screen tab fields
  • Screen schemes
  • Server info
  • Status
  • Tasks
  • Time tracking
  • Users
  • User properties
  • Webhooks
  • Workflows
  • Workflow transition rules
  • Workflow schemes
  • Workflow scheme project associations
  • Workflow scheme drafts
  • Workflow statuses
  • Workflow status categories
  • Workflow transition properties
  • App properties
  • Dynamic modules
  • App migration
  • Service Registry
Cloud
Jira Cloud platform / Reference / REST API v3 (beta)

Dynamic modules

Postman Collection
OpenAPI
GET

Get modules

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 app scope requiredNONE

Request

This request has no parameters.

Responses

Returned if the request is successful.

application/json

ConnectModules
GET/rest/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/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; const response = await api.requestJira(route`/rest/atlassian-connect/1/app/module/dynamic`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 { "jiraEntityProperties": [ { "keyConfigurations": [ { "extractions": [ { "objectName": "extension", "type": "text", "alias": "attachmentExtension" } ], "propertyKey": "attachment" } ], "entityType": "issue", "name": { "value": "Attachment Index Document" }, "key": "dynamic-attachment-entity-property" } ], "jiraIssueFields": [ { "description": { "value": "A dynamically added single-select field" }, "type": "single_select", "extractions": [ { "path": "category", "type": "text", "name": "categoryName" } ], "name": { "value": "Dynamic single select" }, "key": "dynamic-select-field" } ] }
POST

Register modules

Registers a list of modules.

Permissions required: Only Connect apps can make this request.

Data Security Policy: Exempt from app access rules
Scopes

Connect app scope requiredNONE

Request

Request bodyapplication/json

modules

array<ConnectModule>

Required

Responses

Returned if the request is successful.

POST/rest/atlassian-connect/1/app/module/dynamic
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 // 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/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; var bodyData = `{ "jiraEntityProperties": [ { "keyConfigurations": [ { "extractions": [ { "objectName": "extension", "type": "text", "alias": "attachmentExtension" } ], "propertyKey": "attachment" } ], "entityType": "issue", "name": { "value": "Attachment Index Document" }, "key": "dynamic-attachment-entity-property" } ], "jiraIssueFields": [ { "description": { "value": "A dynamically added single-select field" }, "type": "single_select", "extractions": [ { "path": "category", "type": "text", "name": "categoryName" } ], "name": { "value": "Dynamic single select" }, "key": "dynamic-select-field" } ] }`; const response = await api.requestJira(route`/rest/atlassian-connect/1/app/module/dynamic`, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: bodyData }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());
DEL

Remove modules

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 app scope requiredNONE

Request

Query parameters

moduleKey

array<string>

Responses

Returned if the request is successful.

DEL/rest/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/jira/platform/rest/v3/#authentication import api, { route } from "@forge/api"; const response = await api.requestJira(route`/rest/atlassian-connect/1/app/module/dynamic`, { method: 'DELETE' }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.text());

Rate this page: