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"
}
]
}
]
}
'import requests
url = "https://api.example.com/v2/dependencies/dependencies"
payload = { "files": [
{
"file": "package.json",
"purls": [
{
"purl": "pkg:npm/express",
"requirement": "^4.18.0"
}
]
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
files: [
{
file: 'package.json',
purls: [{purl: 'pkg:npm/express', requirement: '^4.18.0'}]
}
]
})
};
fetch('https://api.example.com/v2/dependencies/dependencies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/dependencies/dependencies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'file' => 'package.json',
'purls' => [
[
'purl' => 'pkg:npm/express',
'requirement' => '^4.18.0'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/dependencies/dependencies"
payload := strings.NewReader("{\n \"files\": [\n {\n \"file\": \"package.json\",\n \"purls\": [\n {\n \"purl\": \"pkg:npm/express\",\n \"requirement\": \"^4.18.0\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v2/dependencies/dependencies")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"file\": \"package.json\",\n \"purls\": [\n {\n \"purl\": \"pkg:npm/express\",\n \"requirement\": \"^4.18.0\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/dependencies/dependencies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"file\": \"package.json\",\n \"purls\": [\n {\n \"purl\": \"pkg:npm/express\",\n \"requirement\": \"^4.18.0\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}"<string>"{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Dependencies
Get dependency details Deprecated: Use /v2/licenses/components instead
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"
}
]
}
]
}
'import requests
url = "https://api.example.com/v2/dependencies/dependencies"
payload = { "files": [
{
"file": "package.json",
"purls": [
{
"purl": "pkg:npm/express",
"requirement": "^4.18.0"
}
]
}
] }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
files: [
{
file: 'package.json',
purls: [{purl: 'pkg:npm/express', requirement: '^4.18.0'}]
}
]
})
};
fetch('https://api.example.com/v2/dependencies/dependencies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/dependencies/dependencies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'files' => [
[
'file' => 'package.json',
'purls' => [
[
'purl' => 'pkg:npm/express',
'requirement' => '^4.18.0'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v2/dependencies/dependencies"
payload := strings.NewReader("{\n \"files\": [\n {\n \"file\": \"package.json\",\n \"purls\": [\n {\n \"purl\": \"pkg:npm/express\",\n \"requirement\": \"^4.18.0\"\n }\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/v2/dependencies/dependencies")
.header("Content-Type", "application/json")
.body("{\n \"files\": [\n {\n \"file\": \"package.json\",\n \"purls\": [\n {\n \"purl\": \"pkg:npm/express\",\n \"requirement\": \"^4.18.0\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/dependencies/dependencies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"files\": [\n {\n \"file\": \"package.json\",\n \"purls\": [\n {\n \"purl\": \"pkg:npm/express\",\n \"requirement\": \"^4.18.0\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}"<string>"{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Body
application/json
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"}}
⌘I