Use this API to list, create, and delete the namespace subscriptions of a GitLab for Jira (Forge) installation. For more information, see the Jira integrations.
List GitLab for Jira (Forge) namespace subscriptions
GET /api/v4/integrations/jira_forge/subscriptions
Lists the GitLab namespaces subscribed to the Forge installation.
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | Jira |
401 | Unauthorized | — |
Create a GitLab for Jira (Forge) namespace subscription
POST /api/v4/integrations/jira_forge/subscriptions
Subscribes a GitLab namespace to the Forge installation so its development data syncs to Jira. Authenticated as the GitLab user (OAuth); the Jira installation and user are resolved from the Forge invocation context.
Request body (application/json)
| Property | Type | Description |
|---|---|---|
namespace_Required | String | Path of the namespace to subscribe Maximum length: 255 |
Responses
| Code | Description | Schema |
|---|---|---|
201 | Created | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
403 | Forbidden | — |
404 | Not found | — |
422 | Unprocessable entity | — |
Delete a GitLab for Jira (Forge) namespace subscription
DELETE /api/v4/integrations/jira_forge/subscriptions/{id}
Unsubscribes a GitLab namespace from the Forge installation.
Parameters
| Name | Type | Description |
|---|---|---|
idPath, | Integer | ID of the subscription to delete |
Responses
| Code | Description | Schema |
|---|---|---|
200 | OK | APIEntities |
400 | Bad Request | — |
401 | Unauthorized | — |
403 | Forbidden | — |
404 | Not found | — |
422 | Unprocessable entity | — |
Schemas
Objects returned by the operations above and objects nested in their request bodies.
APIEntitiesBasicSuccess
| Property | Type | Description |
|---|---|---|
success | Object | — |
JiraConnectGroupEntity
| Property | Type | Description |
|---|---|---|
avatar_ | String | — |
description | String | — |
full_ | String | — |
name | String | — |
JiraConnectSubscriptionEntity
| Property | Type | Description |
|---|---|---|
created_ | String | — |
group | Jira | — |
unlink_ | String | — |