Comment on page

Jira integration

Feature availability This feature is available with all paid plans. See pricing plans for more details. For the availability of this feature for Snyk Infrastructure as Code, see Jira Integration for IaC. Snyk Security in Jira Cloud is now available.

Set up your Jira integration

Snyk Jira integration allows you to manually raise Jira issues in the Snyk UI for vulnerabilities or license issues. The Jira integration also includes APIs (see Snyk API docs).
If your Jira instance is private, use the Snyk Broker deployment method.

Prerequisites for Jira integration with Snyk

  • Snyk supports Jira version 5 and later versions.
  • The following Jira permissions are required: Browse Projects and Create Issues.

How to set up your Jira integration

It is best practice to set up a new user in Jira for this integration, instead of using the credentials of an existing account.
Cloud-hosted Jira implementations require a username and API token authentication. Jira API tokens are generated in Atlassian API tokens. Self-hosted implementations can also authenticate with a username and password.
Enter the Jira account credentials in the Snyk Web UI: Organization Settings > Integrations page: Base URL, Username/email, and API token.
Jira settings
Jira settings
After the details have been entered into the integration, press Save and continue.
If the connection is not successful, check that the Base URL starts with exactly https:// It must not have capitals or be http.
If the connection is successful, you will see the connection details in orange at the top of the page, with options for configuring the default Project and issue type, as well as any fields to ignore.
The default Project and issue type must be configured.
A successful connection

Create a Jira issue

After you set up the Jira integration connection, open one of your Snyk Projects in the Snyk Web UI. A new button, Create an issue, appears at the bottom of each vulnerability and license issue card. This button allows you to create a Jira issue.
Create an issue button
Create an issue button
When you select Create an issue, a Jira issue creation form appears. This form includes the Snyk issue details, which are copied into the associated fields. You can review and edit this form before creating the issue.
Select the Jira project to which you want to send the issue. The fields in the example that follows are based on the fields that the specific Project has, so switching between Projects may show different options.
Crate a Jira issue
Crate a Jira issue
After you create a Jira issue, the Jira key with a link is displayed on the issue card. If you are using the Jira API, you can generate multiple Jira issues for the same issue in Snyk.
Jira key on issue card
Jira key on issue card

Integrate with Jira using Snyk Broker