Skip to content

Create or update the Jira integration

PUT
/api/v4/groups/{id}/integrations/jira

Creates or updates the Jira integration.

id
required
One of:
string

The ID or URL-encoded path of the group

Media type application/json
object
url
required

The URL to the Jira project which is being linked to this GitLab project (for example, https://jira.example.com).

string
nullable
api_url

The base URL to the Jira instance API. Web URL value is used if not set (for example, https://jira-api.example.com).

string
nullable
jira_auth_type

The authentication method to use with Jira. Use 0 for basic authentication, 1 for Jira personal access token, and 2 for Jira Cloud service accounts. Defaults to 0.

integer
nullable
username

The email or username to use with Jira. Use an email for Jira Cloud, and a username for Jira Data Center and Jira Server. Required when using basic authentication (jira_auth_type is 0).

string
nullable
password
required

The Jira API token, password, or personal access token to use with Jira. When using Basic Authentication (jira_auth_type is 0), use an API token for Jira Cloud, and a password for Jira Data Center or Jira Server. For a Jira personal access token (jira_auth_type is 1), use the personal access token.

string
nullable
jira_issue_regex

Regular expression to match Jira issue keys.

string
nullable
jira_issue_prefix

Prefix to match Jira issue keys.

string
nullable
jira_issue_transition_id

The ID of one or more transitions for custom issue transitions.Ignored when jira_issue_transition_automatic is enabled. Defaults to a blank string,which disables custom transitions.

string
nullable
issues_enabled

Enable viewing Jira issues in GitLab.

string
nullable
project_keys

Keys of Jira projects to display. When issues_enabled is true, this setting filters which Jira projects are shown in GitLab. It does not restrict the API token’s access.

Array<string>
nullable
vulnerabilities_enabled

Turn on Jira issue creation for GitLab vulnerabilities.

boolean
nullable
vulnerabilities_issuetype

Jira issue type to use when creating issues from vulnerabilities.

string
nullable
project_key

Key of the project to use when creating issues from vulnerabilities.This parameter is required if using the integration to create Jira issues from vulnerabilities.

string
nullable
customize_jira_issue_enabled

When set to true, opens a prefilled form on the Jira instancewhen creating a Jira issue from a vulnerability.

boolean
nullable
jira_check_enabled

Verify Jira issues referenced in commit messages exist before allowing the push.

boolean
nullable
jira_exists_check_enabled

Verify the Jira issues referenced in commit messages exist in Jira.

boolean
nullable
jira_assignee_check_enabled

Verify the committer is the assignee of the Jira issues referenced in commit messages.

boolean
nullable
jira_status_check_enabled

Verify the status of Jira issues referenced in commit messages.

boolean
nullable
jira_allowed_statuses_as_string

Comma-separated list of allowed Jira issue statuses.

string
nullable
comment_on_event_enabled

Enable comments inside Jira issues on each GitLab event (commit / merge request)

boolean
nullable
commit_events

Trigger event when a commit is created or updated.

boolean
nullable
merge_requests_events

Trigger event when a merge request is created, updated, or merged.

boolean
nullable
use_inherited_settings

Indicates whether to inherit the default settings. Defaults to false.

boolean
nullable
Example generated
{
"url": "example",
"api_url": "example",
"jira_auth_type": 1,
"username": "example",
"password": "example",
"jira_issue_regex": "example",
"jira_issue_prefix": "example",
"jira_issue_transition_id": "example",
"issues_enabled": "example",
"project_keys": [
"example"
],
"vulnerabilities_enabled": true,
"vulnerabilities_issuetype": "example",
"project_key": "example",
"customize_jira_issue_enabled": true,
"jira_check_enabled": true,
"jira_exists_check_enabled": true,
"jira_assignee_check_enabled": true,
"jira_status_check_enabled": true,
"jira_allowed_statuses_as_string": "example",
"comment_on_event_enabled": true,
"commit_events": true,
"merge_requests_events": true,
"use_inherited_settings": true
}

OK

Media type application/json
object
id
integer format: int64
title
string
slug
string
created_at
string format: date-time
updated_at
string format: date-time
active
boolean
commit_events
boolean
push_events
boolean
issues_events
boolean
incident_events
boolean
alert_events
boolean
confidential_issues_events
boolean
merge_requests_events
boolean
tag_push_events
boolean
deployment_events
boolean
note_events
boolean
confidential_note_events
boolean
pipeline_events
boolean
wiki_page_events
boolean
job_events
boolean
comment_on_event_enabled
boolean
inherited
boolean
vulnerability_events
boolean
Example
{
"id": 75,
"title": "Jenkins CI",
"slug": "jenkins",
"created_at": "2019-11-20T11:20:25.297Z",
"updated_at": "2019-11-20T12:24:37.498Z"
}

Bad request

Unauthorized

Not found

Unprocessable entity