Dependencies (v1)

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

List all dependencies

post

Required permissions

• View Organization

• View Project

• View Project Snapshot

Path parameters

orgIdstringRequired

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

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

Query parameters

sortByall ofOptional

The field to sort results by.

string · enumOptionalPossible values:

and

anyOptional

The field to sort results by.

Example: dependency

orderall ofOptional

The direction to sort results by.

string · enumOptionalPossible values:

and

anyOptional

The direction to sort results by.

pagenumber · doubleOptional

The page of results to fetch.

perPagenumber · doubleOptional

The number of results to fetch per page (maximum is 1000).

Body

all ofOptional

and

anyOptionalExample: {"filters":{"languages":["cpp","dockerfile","dotnet","elixir","golang","helm","java","javascript","kubernetes","linux","php","python","ruby","scala","swift","terraform"],"projects":[],"dependencies":[],"licenses":[],"severity":["critical","high","medium","low"],"depStatus":""}}

Responses

200Success

application/json; charset=utf-8

Responseall of

and

anyOptionalExample: {"results":[{"id":"[email protected]","name":"gulp","version":"3.9.1","latestVersion":"4.0.0","latestVersionPublishedDate":"2018-01-01T01:29:06.863Z","firstPublishedDate":"2013-07-04T23:27:07.828Z","isDeprecated":false,"deprecatedVersions":["0.0.1","0.0.2","0.0.3"],"licenses":[{"id":"snyk:lic:npm:gulp:MIT","title":"MIT license","license":"MIT"}],"dependenciesWithIssues":["[email protected]","[email protected]"],"type":"npm","projects":[{"name":"atokeneduser/goof","id":"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"}]}],"total":1}

post

HTTPcURLJavaScriptPython

POST /v1/org/{orgId}/dependencies HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 278

{
  "filters": {
    "languages": [
      "cpp",
      "dockerfile",
      "dotnet",
      "elixir",
      "golang",
      "helm",
      "java",
      "javascript",
      "kubernetes",
      "linux",
      "php",
      "python",
      "ruby",
      "scala",
      "swift",
      "terraform"
    ],
    "projects": [],
    "dependencies": [],
    "licenses": [],
    "severity": [
      "critical",
      "high",
      "medium",
      "low"
    ],
    "depStatus": ""
  }
}

200Success

{
  "results": [
    {
      "id": "[email protected]",
      "name": "gulp",
      "version": "3.9.1",
      "latestVersion": "4.0.0",
      "latestVersionPublishedDate": "2018-01-01T01:29:06.863Z",
      "firstPublishedDate": "2013-07-04T23:27:07.828Z",
      "isDeprecated": false,
      "deprecatedVersions": [
        "0.0.1",
        "0.0.2",
        "0.0.3"
      ],
      "licenses": [
        {
          "id": "snyk:lic:npm:gulp:MIT",
          "title": "MIT license",
          "license": "MIT"
        }
      ],
      "dependenciesWithIssues": [
        "[email protected]",
        "[email protected]"
      ],
      "type": "npm",
      "projects": [
        {
          "name": "atokeneduser/goof",
          "id": "6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
        }
      ]
    }
  ],
  "total": 1
}