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)
| Property | Type | Description |
|---|---|---|
instance_ | String | Base URL of the self- Maximum length: 1024 |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
403 | Forbidden | — |
422 | Unprocessable entity | — |
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
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
422 | Unprocessable entity | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesBasicSuccess
| Property | Type | Description |
|---|---|---|
success | Object | — |