Skip to main content
POST
/
v2
/
dependencies
/
dependencies
Get dependency details Deprecated: Use /v2/licenses/components instead
curl --request POST \
  --url https://api.example.com/v2/dependencies/dependencies \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "file": "package.json",
      "purls": [
        {
          "purl": "pkg:npm/express",
          "requirement": "^4.18.0"
        }
      ]
    }
  ]
}
'
{
  "files": [
    {
      "file": "package.json",
      "id": "dependency",
      "status": "pending",
      "dependencies": [
        {
          "component": "express",
          "purl": "pkg:npm/express",
          "version": "4.18.2",
          "requirement": "^4.18.0",
          "licenses": [
            {
              "name": "MIT",
              "spdx_id": "MIT",
              "is_spdx_approved": true,
              "url": "https://opensource.org/licenses/MIT"
            }
          ],
          "url": "https://www.npmjs.com/package/express",
          "comment": ""
        }
      ]
    }
  ],
  "status": {
    "status": "SUCCESS",
    "message": "Dependencies successfully retrieved"
  }
}

Body

application/json
​
files
List of dependency files · object[]
​
depth
integer<int32>

Response

A successful response.

Success example. For error cases, each dependency block reports the processing status via info_message and info_code. Example: {"files":[{"file":"package.json","id":"dependency","status":"pending","dependencies":[{"component":"","purl":"pkg:npm/express","info_message":"Component not found","info_code":"COMPONENT_NOT_FOUND"}]}],"status":{"status":"SUCCESS","message":"Success"}}

​
files
Dependency response details · object[]
​
status
object

Detailed response details.