GIgitlab
integrations

Create or update the Jira integration

Creates or updates the Jira integration.

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

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Path parameters

idinteger required

Request body

urlstring required

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

api_urlstring

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

jira_auth_typeinteger

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.

usernamestring

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).

passwordstring 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.

jira_issue_regexstring

Regular expression to match Jira issue keys.

jira_issue_prefixstring

Prefix to match Jira issue keys.

jira_issue_transition_idstring

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.

issues_enabledstring

Enable viewing Jira issues in GitLab.

project_keysstring[]

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.

vulnerabilities_enabledboolean

Turn on Jira issue creation for GitLab vulnerabilities.

vulnerabilities_issuetypestring

Jira issue type to use when creating issues from vulnerabilities.

project_keystring

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.

customize_jira_issue_enabledboolean

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

jira_check_enabledboolean

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

jira_exists_check_enabledboolean

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

jira_assignee_check_enabledboolean

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

jira_status_check_enabledboolean

Verify the status of Jira issues referenced in commit messages.

jira_allowed_statuses_as_stringstring

Comma-separated list of allowed Jira issue statuses.

comment_on_event_enabledboolean

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

commit_eventsboolean

Trigger event when a commit is created or updated.

merge_requests_eventsboolean

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

use_inherited_settingsboolean

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

Response

Create or update the Jira integration

idinteger required
titlestring required
slugstring required
created_atstring date-time required
updated_atstring date-time required
activeboolean required
commit_eventsboolean required
push_eventsboolean required
issues_eventsboolean required
incident_eventsboolean required
alert_eventsboolean required
confidential_issues_eventsboolean required
merge_requests_eventsboolean required
tag_push_eventsboolean required
deployment_eventsboolean required
note_eventsboolean required
confidential_note_eventsboolean required
pipeline_eventsboolean required
wiki_page_eventsboolean required
job_eventsboolean required
comment_on_event_enabledboolean required
inheritedboolean required
vulnerability_eventsboolean required

Example response

{
  "id": 75,
  "title": "Jenkins CI",
  "slug": "jenkins",
  "created_at": "2019-11-20T11:20:25.297Z",
  "updated_at": "2019-11-20T12:24:37.498Z"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.