Ignores (v1)

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

List all ignores

Ignores from .snyk files are not included here. Ignores from Policies are not included here.Temporary ignores include an expires attribute, while permanent ignores do not.

Required permissions

• View Organization

• View Project

• View Project Ignores

GEThttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignores

Path parameters

orgId*string

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

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

projectId*string

The project ID to list ignores for.

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

Header parameters

Response

200

Body

application/json; charset=utf-8

issueId*array of Ignore

The issue ID that should be ignored.

Request

JavaScriptCurlPython

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

Response

200

{
  "issueId": [
    {
      "ignorePath": {
        "reason": "text",
        "reasonType": {},
        "ignoredBy": {
          "name": "text",
          "email": "text",
          "id": "text"
        },
        "disregardIfFixable": false,
        "expires": "text",
        "created": "text"
      }
    }
  ]
}

Replace ignores

It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project. Ignores from .snyk files are not included here

Required permissions

• View Organization

• View Project Ignores

• Edit Project Ignores

PUThttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}

Path parameters

orgId*string

The organization ID to modify ignores for. The API_KEY must have access to this organization.

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

projectId*string

The project ID to modify ignores for.

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

issueId*string

The issue ID to modify ignores for. Can be a vulnerability or a license Issue.

Example: "npm:qs:20140806-1"

Body

application/json

ignorePathstring

The path to ignore (default is * which represents all paths).

reasonstring

The reason that the issue was ignored.

reasonTypeall of

disregardIfFixable*boolean

Only ignore the issue if no upgrade or patch is available.

expiresstring

The timestamp that the issue will no longer be ignored.

Response

200

Body

application/json; charset=utf-8

ignorePath*all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "ignorePath": "",
        "reason": "",
        "reasonType": "not-vulnerable",
        "disregardIfFixable": false,
        "expires": ""
      }
    ]),
});
const data = await response.json();

Response

200

[
  {
    "ignorePath": {
      "reason": "text",
      "reasonType": {},
      "ignoredBy": {
        "name": "text",
        "email": "text",
        "id": "text"
      },
      "disregardIfFixable": false,
      "expires": "text",
      "created": "text"
    }
  }
]

Add ignore

It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project. Ignores from .snyk files are not included here

Required permissions

• View Organization

• View Project Ignores

• Create new project ignores

POSThttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}

Path parameters

orgId*string

The organization ID to modify ignores for. The API_KEY must have access to this organization.

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

projectId*string

The project ID to modify ignores for.

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

issueId*string

The issue ID to modify ignores for. Can be a vulnerability or a license Issue.

Example: "npm:qs:20140806-1"

Body

application/json

ignorePathstring

The path to ignore (default is * which represents all paths).

reasonstring

The reason that the issue was ignored.

reasonType*all of

disregardIfFixable*boolean

Only ignore the issue if no upgrade or patch is available.

expiresstring

The timestamp that the issue will no longer be ignored.

any

Response

200

Body

application/json; charset=utf-8

ignorePath*all of

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ignorePath": "",
      "reason": "",
      "reasonType": "not-vulnerable",
      "disregardIfFixable": false,
      "expires": ""
    }),
});
const data = await response.json();

Response

200

{
  "ignorePath": {
    "reason": "text",
    "reasonType": {},
    "ignoredBy": {
      "name": "text",
      "email": "text",
      "id": "text"
    },
    "disregardIfFixable": false,
    "expires": "text",
    "created": "text"
  }
}

Retrieve ignore

It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project. Ignores from .snyk files are not included here

Required permissions

• View Project

• View Project Ignores

GEThttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}

Path parameters

orgId*string

The organization ID to modify ignores for. The API_KEY must have access to this organization.

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

projectId*string

The project ID to modify ignores for.

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

issueId*string

The issue ID to modify ignores for. Can be a vulnerability or a license Issue.

Example: "npm:qs:20140806-1"

Header parameters

Response

200

Body

application/json; charset=utf-8

ignorePath*all of

Request

JavaScriptCurlPython

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

Response

200

{
  "ignorePath": {
    "reason": "text",
    "reasonType": {},
    "ignoredBy": {
      "name": "text",
      "email": "text",
      "id": "text"
    },
    "disregardIfFixable": false,
    "expires": "text",
    "created": "text"
  }
}

Delete ignores

It is possible to modify/retrieve ignored vulnerability or license issues for a given organization and project. Ignores from .snyk files are not included here

Required permissions

• View Organization

• View Project Ignores

• Remove Project Ignores

DELETEhttps://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}

Path parameters

orgId*string

The organization ID to modify ignores for. The API_KEY must have access to this organization.

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

projectId*string

The project ID to modify ignores for.

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

issueId*string

The issue ID to modify ignores for. Can be a vulnerability or a license Issue.

Example: "npm:qs:20140806-1"

Header parameters

Response

200

Request

JavaScriptCurlPython

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