Jira forge installation

Use this API to configure a GitLab for Jira (Forge) installation, by setting the GitLab instance URL it points to and registering the system token it uses to synchronize development information. For more information, see the Jira integrations.

Update the GitLab for Jira (Forge) installation instance URL

PUT /api/v4/integrations/jira_forge/installation

Sets the GitLab instance the installation points at. Omit instance_url (or send null) for GitLab.com. Requires a Jira site or organization admin.

Request body (application/json)

Responses

Destroy the GitLab for Jira (Forge) installation on app uninstall

DELETE /api/v4/integrations/jira_forge/installation

Called by the Forge app preUninstall hook. A pure-native install fires no Connect uninstalled event, so this is what removes the installation, its subscriptions, and deactivates the linked jira_cloud_app integrations. FIT authentication carries the same trust as the signed Connect lifecycle event, so no Jira admin check is needed. Succeeds with no change when the installation is already gone.

Responses

Register the GitLab for Jira (Forge) system token for direct dev-info sync

POST /api/v4/integrations/jira_forge/installation/forge_token

Stores the Forge app system OAuth token (X-Forge-Oauth-System header) and the Jira apiBaseUrl (from the FIT), so GitLab pushes dev-info directly to Jira. See Atlassian::Forge::SystemTokenClient.

Responses

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesBasicSuccess