Jira (v1)

This document uses the v1 API. For more details, see the v1 API.

List all jira issues

If you have configured an integration with Jira, it is possible to create Jira issues for project vulnerabilities or license issues directly from the Snyk API.

The Jira integration is available to customers on the pro or enterprise plan.

At the moment, the usage of the Jira integration via the API is not supported for Snyk Infrastructure as Code

Required permissions

• View Jira issues

GEThttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/jira-issues

Path parameters

orgId*string

The organization ID to list Jira issues for. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

projectId*string

The project ID to list Jira issues for.

Example: "463c1ee5-31bc-428c-b451-b79a3270db08"

Header parameters

Response

200

Body

application/json; charset=utf-8

issueId*array of Jiraissue

The issue ID and relating jira issue.

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/project/{projectId}/jira-issues', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "issueId": [
    {
      "jiraIssue": {
        "id": "text",
        "key": "text"
      }
    }
  ]
}

Create jira issue

If you have configured an integration with Jira, it is possible to create Jira issues for project vulnerabilities or license issues directly from the Snyk API.

The Jira integration is available to customers on the pro or enterprise plan.

At the moment, the usage of the Jira integration via the API is not supported for Snyk Infrastructure as Code

Required permissions

• Create Jira issues

POSThttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/issue/{issueId}/jira-issue

Path parameters

orgId*string

The organization ID to list Jira issues for. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

projectId*string

The project ID to list Jira issues for.

Example: "463c1ee5-31bc-428c-b451-b79a3270db08"

issueId*string

The issue ID to create Jira issue for.

Example: "npm:qs:20140806-1"

Body

application/json

fieldsfields

any

Response

200

Body

application/json; charset=utf-8

jiraIssueall of

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/project/{projectId}/issue/{issueId}/jira-issue', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fields": {
        "project": {},
        "issuetype": {},
        "summary": ""
      }
    }),
});
const data = await response.json();

Response

200

{
  "jiraIssue": {
    "id": "10001",
    "key": "EX-1"
  }
}