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

get

/org/{orgId}/project/{projectId}/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

Header parameters

Content-Typestring · enumrequired

Example: application/json

Options: application/json

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignores' \
  --header 'Content-Type: application/json'

200

200

{
  "issueId": [
    {
      "ignorePath": {
        "reason": "text",
        "disregardIfFixable": true,
        "expires": "text",
        "created": "text",
        "reasonType": null,
        "ignoredBy": {
          "name": "text",
          "email": "text",
          "id": "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

put

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

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: npm:qs:20140806-1

Body

ignorePathstring

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

reasonstring

The reason that the issue was ignored.

disregardIfFixablebooleanrequired

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

expiresstring

The timestamp that the issue will no longer be ignored.

reasonTypeall of

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}' \
  --header 'Content-Type: application/json' \
  --data '[{"ignorePath":"","reason":"","reasonType":"not-vulnerable","disregardIfFixable":false,"expires":""}]'

200

200

[
  {
    "ignorePath": {
      "reason": "text",
      "disregardIfFixable": true,
      "expires": "text",
      "created": "text",
      "reasonType": null,
      "ignoredBy": {
        "name": "text",
        "email": "text",
        "id": "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

post

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

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: npm:qs:20140806-1

Body

ignorePathstring

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

reasonstring

The reason that the issue was ignored.

disregardIfFixablebooleanrequired

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

expiresstring

The timestamp that the issue will no longer be ignored.

reasonTypeall ofrequired

any

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

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}' \
  --header 'Content-Type: application/json' \
  --data '{"ignorePath":"","reason":"","reasonType":"not-vulnerable","disregardIfFixable":false,"expires":""}'

200

200

{
  "ignorePath": {
    "reason": "text",
    "disregardIfFixable": true,
    "expires": "text",
    "created": "text",
    "reasonType": null,
    "ignoredBy": {
      "name": "text",
      "email": "text",
      "id": "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

get

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

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: npm:qs:20140806-1

Header parameters

Content-Typestring · enumrequired

Example: application/json

Options: application/json

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}' \
  --header 'Content-Type: application/json'

200

200

{
  "ignorePath": {
    "reason": "text",
    "disregardIfFixable": true,
    "expires": "text",
    "created": "text",
    "reasonType": null,
    "ignoredBy": {
      "name": "text",
      "email": "text",
      "id": "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

delete

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

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: npm:qs:20140806-1

Header parameters

Content-Typestring · enumrequired

Example: application/json

Options: application/json

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/v1/org/{orgId}/project/{projectId}/ignore/{issueId}' \
  --header 'Content-Type: application/json'

200

200

No body