Ignores (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 ignores

get

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

Path parameters

orgIdstringRequired

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

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

projectIdstringRequired

The project ID to list ignores for.

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

Responses

200Success

application/json

get

/org/{orgId}/project/{projectId}/ignores

HTTPcURLJavaScriptPython

GET /v1/org/{orgId}/project/{projectId}/ignores HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

{
  "issueId": [
    {
      "ignorePath": {
        "reason": "text",
        "reasonType": "not-vulnerable",
        "ignoredBy": {
          "name": "text",
          "email": "text",
          "id": "text"
        },
        "disregardIfFixable": true,
        "expires": "text",
        "created": "text"
      }
    }
  ]
}

Replace ignores

put

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

Path parameters

orgIdstringRequired

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

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

projectIdstringRequired

The project ID to modify ignores for.

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

issueIdstringRequired

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

Example: SNYK-JS-QS-10019

Bodyobject · Ignorerules[]

application/json

ignorePathstringOptional

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

reasonstringOptional

The reason that the issue was ignored.

reasonTypeall ofOptional

string · enumOptional

The classification of the ignore.

Possible values:

and

anyOptional

The classification of the ignore.

disregardIfFixablebooleanRequired

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

expiresstringOptional

The timestamp that the issue will no longer be ignored.

Responses

200Success

application/json

put

/org/{orgId}/project/{projectId}/ignore/{issueId}

HTTPcURLJavaScriptPython

PUT /v1/org/{orgId}/project/{projectId}/ignore/{issueId} HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 101

[
  {
    "ignorePath": "",
    "reason": "",
    "reasonType": "not-vulnerable",
    "disregardIfFixable": false,
    "expires": ""
  }
]

200Success

[
  {
    "ignorePath": {
      "reason": "text",
      "reasonType": "not-vulnerable",
      "ignoredBy": {
        "name": "text",
        "email": "text",
        "id": "text"
      },
      "disregardIfFixable": true,
      "expires": "text",
      "created": "text"
    }
  }
]

Add ignore

post

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

Path parameters

orgIdstringRequired

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

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

projectIdstringRequired

The project ID to modify ignores for.

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

issueIdstringRequired

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

Example: SNYK-JS-QS-10019

Body

application/json

ignorePathstringOptional

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

reasonstringOptional

The reason that the issue was ignored.

reasonTypeall ofRequired

string · enumOptional

The classification of the ignore.

Possible values:

and

anyOptional

The classification of the ignore.

disregardIfFixablebooleanRequired

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

expiresstringOptional

The timestamp that the issue will no longer be ignored.

Responses

200Success

application/json

post

/org/{orgId}/project/{projectId}/ignore/{issueId}

HTTPcURLJavaScriptPython

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

{
  "ignorePath": "",
  "reason": "",
  "reasonType": "not-vulnerable",
  "disregardIfFixable": false,
  "expires": ""
}

200Success

{
  "ignorePath": {
    "reason": "text",
    "reasonType": "not-vulnerable",
    "ignoredBy": {
      "name": "text",
      "email": "text",
      "id": "text"
    },
    "disregardIfFixable": true,
    "expires": "text",
    "created": "text"
  }
}

Retrieve ignore

get

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

Path parameters

orgIdstringRequired

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

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

projectIdstringRequired

The project ID to modify ignores for.

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

issueIdstringRequired

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

Example: SNYK-JS-QS-10019

Responses

200Success

application/json

get

/org/{orgId}/project/{projectId}/ignore/{issueId}

HTTPcURLJavaScriptPython

GET /v1/org/{orgId}/project/{projectId}/ignore/{issueId} HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

{
  "ignorePath": {
    "reason": "text",
    "reasonType": "not-vulnerable",
    "ignoredBy": {
      "name": "text",
      "email": "text",
      "id": "text"
    },
    "disregardIfFixable": true,
    "expires": "text",
    "created": "text"
  }
}

Delete ignores

delete

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

Path parameters

orgIdstringRequired

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

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

projectIdstringRequired

The project ID to modify ignores for.

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

issueIdstringRequired

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

Example: SNYK-JS-QS-10019

Responses

200Success

delete

/org/{orgId}/project/{projectId}/ignore/{issueId}

HTTPcURLJavaScriptPython

DELETE /v1/org/{orgId}/project/{projectId}/ignore/{issueId} HTTP/1.1
Host: api.snyk.io
Accept: */*

200Success

No content