Jira (v1)

This document uses the v1 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

Header parameters

Content-Typestring · enumRequiredExample: application/jsonPossible values:

Responses

200Success

application/json; charset=utf-8

get

HTTPcURLJavaScriptPython

GET /v1/org/{orgId}/project/{projectId}/jira-issues HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*

200Success

{
  "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

all ofOptional

and

anyOptionalExample: {"fields":{"project":{},"issuetype":{},"summary":""}}

Responses

200Success

application/json; charset=utf-8

Responseall of

and

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

post

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/project/{projectId}/issue/{issueId}/jira-issue HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "fields": {
    "project": {},
    "issuetype": {},
    "summary": ""
  }
}

200Success

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