SupportSnyk LearnAPI referenceProduct updatesSign up for free

Snapshots (v1)

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

List all project snapshots

post

Required permissions

  • View Organization

  • View Project

  • View Project Snapshot

Path parameters
orgIdstringRequired

The organization ID. The API_KEY must have access to this organization.

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

The project ID to return snapshots for.

Example: 6d5813be-7e6d-4ab8-80c2-1e3e2a454545
Query parameters
perPagenumber · doubleOptional

The number of results to return (the default is 10, the maximum is 100).

Example: 10
pagenumber · doubleOptional

The offset from which to start returning results from.

Example: 1
Body
all ofOptional
and
anyOptionalExample: {"filters":{"imageId":"sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67"}}
Responses
200Success
application/json; charset=utf-8
Responseall of
and
anyOptionalExample: {"snapshots":[{"id":"6d5813be-7e6d-4ab8-80c2-1e3e2a454545","created":"2019-02-05T06:21:00.000Z","totalDependencies":438,"issueCounts":{"vuln":{"low":8,"medium":15,"high":13,"critical":0},"license":{"low":8,"medium":15,"high":13,"critical":0}},"imageId":"sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67","imageTag":"latest","imagePlatform":"linux/amd64","baseImageName":"fedora:32","method":"web-test"},{"id":"6d5813be-7e6d-4ab8-80c2-1e3e2a454553","created":"2019-02-04T06:19:00.000Z","totalDependencies":438,"issueCounts":{"vuln":{"low":8,"medium":15,"high":13,"critical":0},"license":{"low":8,"medium":15,"high":13,"critical":0}},"imageId":"sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67","imageTag":"latest","imagePlatform":"linux/amd64","baseImageName":"fedora:32","method":"web-test"}],"total":2}
post
POST /v1/org/{orgId}/project/{projectId}/history HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "filters": {
    "imageId": "sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67"
  }
}
200Success
{
  "snapshots": [
    {
      "id": "6d5813be-7e6d-4ab8-80c2-1e3e2a454545",
      "created": "2019-02-05T06:21:00.000Z",
      "totalDependencies": 438,
      "issueCounts": {
        "vuln": {
          "low": 8,
          "medium": 15,
          "high": 13,
          "critical": 0
        },
        "license": {
          "low": 8,
          "medium": 15,
          "high": 13,
          "critical": 0
        }
      },
      "imageId": "sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67",
      "imageTag": "latest",
      "imagePlatform": "linux/amd64",
      "baseImageName": "fedora:32",
      "method": "web-test"
    },
    {
      "id": "6d5813be-7e6d-4ab8-80c2-1e3e2a454553",
      "created": "2019-02-04T06:19:00.000Z",
      "totalDependencies": 438,
      "issueCounts": {
        "vuln": {
          "low": 8,
          "medium": 15,
          "high": 13,
          "critical": 0
        },
        "license": {
          "low": 8,
          "medium": 15,
          "high": 13,
          "critical": 0
        }
      },
      "imageId": "sha256:a368cbcfa6789bc347345f6d78902afe138b62ff5373d2aa5f37120277c90a67",
      "imageTag": "latest",
      "imagePlatform": "linux/amd64",
      "baseImageName": "fedora:32",
      "method": "web-test"
    }
  ],
  "total": 2
}

List all project snapshot issue paths

get

Required permissions

  • View Organization

  • View Project

  • View Project Snapshot

Path parameters
orgIdstringRequired

The organization ID. The API_KEY must have access to this organization.

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

The project ID for which to return issue paths.

Example: 6d5813be-7e6d-4ab8-80c2-1e3e2a454545
snapshotIdstringRequired

The project snapshot ID for which to return issue paths. If set to latest, the most recent snapshot will be used. Use the "List all project snapshots" endpoint to find suitable values for this.

Example: 6d5813be-7e6d-4ab8-80c2-1e3e2a454553
issueIdstringRequired

The issue ID for which to return issue paths.

Example: SNYK-JS-LODASH-590103
Query parameters
perPagenumber · doubleOptional

The number of results to return per page (1 - 1000, inclusive).

Example: 3
pagenumber · doubleOptional

The page of results to return.

Example: 2
Header parameters
Content-Typestring · enumRequiredExample: application/jsonPossible values:
Responses
200Success
application/json; charset=utf-8
Responseall of
and
anyOptionalExample: {"snapshotId":"6d5813be-7e6d-4ab8-80c2-1e3e2a454553","paths":[[{"name":"tap","version":"11.1.5"},{"name":"nyc","version":"11.9.0"},{"name":"istanbul-lib-instrument","version":"1.10.1"},{"name":"babel-traverse","version":"6.26.0"},{"name":"lodash","version":"4.17.10"}],[{"name":"tap","version":"11.1.5","fixVersion":"11.1.5"},{"name":"nyc","version":"11.9.0"},{"name":"istanbul-lib-instrument","version":"1.10.1"},{"name":"babel-template","version":"6.26.0"},{"name":"lodash","version":"4.17.10"}],[{"name":"tap","version":"11.1.5","fixVersion":"11.1.6"},{"name":"nyc","version":"11.9.0"},{"name":"istanbul-lib-instrument","version":"1.10.1"},{"name":"babel-generator","version":"6.26.1"},{"name":"babel-types","version":"6.26.0"},{"name":"lodash","version":"4.17.10"}]],"total":10,"links":{"prev":"https://api.snyk.io/v1/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/6d5813be-7e6d-4ab8-80c2-1e3e2a454545/history/6d5813be-7e6d-4ab8-80c2-1e3e2a454553/issue/SNYK-JS-LODASH-590103?page=1&perPage=3","next":"https://api.snyk.io/v1/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/6d5813be-7e6d-4ab8-80c2-1e3e2a454545/history/6d5813be-7e6d-4ab8-80c2-1e3e2a454553/issue/SNYK-JS-LODASH-590103?page=3&perPage=3","last":"https://api.snyk.io/v1/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/6d5813be-7e6d-4ab8-80c2-1e3e2a454545/history/6d5813be-7e6d-4ab8-80c2-1e3e2a454553/issue/SNYK-JS-LODASH-590103?page=4&perPage=3"}}
get
GET /v1/org/{orgId}/project/{projectId}/history/{snapshotId}/issue/{issueId}/paths HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
200Success
{
  "snapshotId": "6d5813be-7e6d-4ab8-80c2-1e3e2a454553",
  "paths": [
    [
      {
        "name": "tap",
        "version": "11.1.5"
      },
      {
        "name": "nyc",
        "version": "11.9.0"
      },
      {
        "name": "istanbul-lib-instrument",
        "version": "1.10.1"
      },
      {
        "name": "babel-traverse",
        "version": "6.26.0"
      },
      {
        "name": "lodash",
        "version": "4.17.10"
      }
    ],
    [
      {
        "name": "tap",
        "version": "11.1.5",
        "fixVersion": "11.1.5"
      },
      {
        "name": "nyc",
        "version": "11.9.0"
      },
      {
        "name": "istanbul-lib-instrument",
        "version": "1.10.1"
      },
      {
        "name": "babel-template",
        "version": "6.26.0"
      },
      {
        "name": "lodash",
        "version": "4.17.10"
      }
    ],
    [
      {
        "name": "tap",
        "version": "11.1.5",
        "fixVersion": "11.1.6"
      },
      {
        "name": "nyc",
        "version": "11.9.0"
      },
      {
        "name": "istanbul-lib-instrument",
        "version": "1.10.1"
      },
      {
        "name": "babel-generator",
        "version": "6.26.1"
      },
      {
        "name": "babel-types",
        "version": "6.26.0"
      },
      {
        "name": "lodash",
        "version": "4.17.10"
      }
    ]
  ],
  "total": 10,
  "links": {
    "prev": "https://api.snyk.io/v1/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/6d5813be-7e6d-4ab8-80c2-1e3e2a454545/history/6d5813be-7e6d-4ab8-80c2-1e3e2a454553/issue/SNYK-JS-LODASH-590103?page=1&perPage=3",
    "next": "https://api.snyk.io/v1/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/6d5813be-7e6d-4ab8-80c2-1e3e2a454545/history/6d5813be-7e6d-4ab8-80c2-1e3e2a454553/issue/SNYK-JS-LODASH-590103?page=3&perPage=3",
    "last": "https://api.snyk.io/v1/org/4a18d42f-0706-4ad0-b127-24078731fbed/project/6d5813be-7e6d-4ab8-80c2-1e3e2a454545/history/6d5813be-7e6d-4ab8-80c2-1e3e2a454553/issue/SNYK-JS-LODASH-590103?page=4&perPage=3"
  }
}

List all project snapshot aggregated issues

post

Required permissions

  • View Organization

  • View Project

  • View Project Snapshot

Path parameters
orgIdstringRequired

The organization ID. The API_KEY must have access to this organization.

Example: 2d5c4d0c-c6d6-4658-a703-c2721c135b26
projectIdstringRequired

The project ID.

Example: 6d5813be-7e6d-4ab8-80c2-1e3e2a454545
snapshotIdstringRequired

The snapshot ID. If set to latest, the most recent snapshot will be used.

Example: 6d5813be-7e6d-4ab8-80c2-1e3e2a454553
Body
all ofOptional
and
anyOptionalExample: {"includeDescription":false,"includeIntroducedThrough":false}
Responses
200Success
application/json; charset=utf-8
post
POST /v1/org/{orgId}/project/{projectId}/history/{snapshotId}/aggregated-issues HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "includeDescription": false,
  "includeIntroducedThrough": false
}
200Success
{
  "issues": [
    {
      "id": "npm:ms:20170412",
      "issueType": "vuln",
      "pkgName": "ms",
      "pkgVersions": [
        "text"
      ],
      "issueData": {
        "id": "npm:ms:20170412",
        "title": "Regular Expression Denial of Service (ReDoS)",
        "severity": "low",
        "originalSeverity": "high",
        "url": "https://snyk.io/vuln/npm:ms:20170412",
        "description": "`## Overview\\r\\n[`ms`](https://www.npmjs.com/package/ms) is a tiny millisecond conversion utility.\\r\\n\\r\\nAffected versions of this package are vulnerable to Regular Expression Denial of Service (ReDoS) due to an incomplete fix for previously reported vulnerability [npm:ms:20151024](https://snyk.io/vuln/npm:ms:20151024). The fix limited the length of accepted input string to 10,000 characters, and turned to be insufficient making it possible to block the event loop for 0.3 seconds (on a typical laptop) with a specially crafted string passed to `ms",
        "identifiers": {
          "CVE": [
            "text"
          ],
          "CWE": [
            "text"
          ],
          "OSVDB": [
            "text"
          ]
        },
        "credit": [
          "text"
        ],
        "exploitMaturity": "no-known-exploit",
        "semver": {
          "vulnerable": [
            "text"
          ],
          "unaffected": "text"
        },
        "publicationTime": "2017-05-15T06:02:45Z",
        "disclosureTime": "2017-04-11T21:00:00Z",
        "CVSSv3": "CVSS:3.0/AV:N/AC:H/PR:N/UI:N/S:U/C:N/I:N/A:L",
        "cvssScore": 3.7,
        "severities": [
          {
            "assigner": "NVD",
            "severity": "medium",
            "baseScore": 4.8,
            "vector": "CVSS:4.0/AV:N/AC:H/AT:N/PR:L/UI:A/VC:N/VI:N/VA:N/SC:H/SI:L/SA:L/E:A",
            "cvssVersion": "4.0",
            "modificationTime": "2024-03-07T07:47:26.644482Z"
          }
        ],
        "exploitDetails": {
          "sources": [
            "CISA"
          ],
          "maturityLevels": [
            {
              "format": "CVSS_v3",
              "level": "no-known-exploit"
            }
          ]
        },
        "language": "js",
        "patches": [
          {
            "id": "patch:npm:ms:20170412:0",
            "urls": [
              "text"
            ],
            "version": "=1.0.0",
            "comments": [
              "text"
            ],
            "modificationTime": "2019-12-03T11:40:45.863964Z"
          }
        ],
        "nearestFixedInVersion": "2.0.0",
        "path": "[DocId: 1].input.spec.template.spec.containers[snyk2].securityContext.privileged",
        "violatedPolicyPublicId": "SNYK-CC-K8S-1",
        "isMaliciousPackage": true
      },
      "introducedThrough": [
        {
          "kind": "imageLayer",
          "data": {}
        }
      ],
      "isPatched": true,
      "isIgnored": true,
      "ignoreReasons": [
        {
          "reason": "text",
          "expires": "text",
          "source": null
        }
      ],
      "fixInfo": {
        "isUpgradable": true,
        "isPinnable": true,
        "isPatchable": true,
        "isFixable": true,
        "isPartiallyFixable": true,
        "nearestFixedInVersion": "2.0.0",
        "fixedIn": [
          "text"
        ]
      },
      "priority": {
        "score": 399,
        "factors": [
          {}
        ]
      },
      "links": {
        "paths": "text"
      }
    }
  ]
}
PreviousSlackNextTargets

Last updated

Was this helpful?

Revision created

Add comment to emphasize required filters hidden in GitBook collapsed field