Jira (v1)

This document uses the v1 API, which will eventually be deprecated, as further Snyk developments are now focused on the REST API. For more details, see the v1 API.

List all jira issues

get

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

Path parameters

orgIdstringrequired

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

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

projectIdstringrequired

The project ID to list Jira issues for.

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/jira-issues'

200

200

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

Create jira issue

post

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

Path parameters

orgIdstringrequired

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

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

projectIdstringrequired

The project ID to list Jira issues for.

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

issueIdstringrequired

The issue ID to create Jira issue for.

Example: npm:qs:20140806-1

Body

fieldsobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/issue/{issueId}/jira-issue' \
  --header 'Content-Type: application/json' \
  --data '{
    "fields": {
      "project": {},
      "issuetype": {},
      "summary": ""
    }
  }'

200

200

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