Scan the given folder request looking for matches
curl --request POST \
--url https://api.example.com/v2/scanning/hfh/scan \
--header 'Content-Type: application/json' \
--data '
{
"root": {
"path_id": "<string>",
"sim_hash_names": "<string>",
"sim_hash_content": "<string>",
"children": "<array>",
"sim_hash_dir_names": "<string>",
"lang_extensions": {}
},
"rank_threshold": 123,
"category": "<string>",
"query_limit": 123,
"recursive_threshold": 123,
"min_accepted_score": 123
}
'import requests
url = "https://api.example.com/v2/scanning/hfh/scan"
payload = {
"root": {
"path_id": "<string>",
"sim_hash_names": "<string>",
"sim_hash_content": "<string>",
"children": "<array>",
"sim_hash_dir_names": "<string>",
"lang_extensions": {}
},
"rank_threshold": 123,
"category": "<string>",
"query_limit": 123,
"recursive_threshold": 123,
"min_accepted_score": 123
}
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({
root: {
path_id: '<string>',
sim_hash_names: '<string>',
sim_hash_content: '<string>',
children: '<array>',
sim_hash_dir_names: '<string>',
lang_extensions: {}
},
rank_threshold: 123,
category: '<string>',
query_limit: 123,
recursive_threshold: 123,
min_accepted_score: 123
})
};
fetch('https://api.example.com/v2/scanning/hfh/scan', 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/scanning/hfh/scan",
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([
'root' => [
'path_id' => '<string>',
'sim_hash_names' => '<string>',
'sim_hash_content' => '<string>',
'children' => '<array>',
'sim_hash_dir_names' => '<string>',
'lang_extensions' => [
]
],
'rank_threshold' => 123,
'category' => '<string>',
'query_limit' => 123,
'recursive_threshold' => 123,
'min_accepted_score' => 123
]),
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/scanning/hfh/scan"
payload := strings.NewReader("{\n \"root\": {\n \"path_id\": \"<string>\",\n \"sim_hash_names\": \"<string>\",\n \"sim_hash_content\": \"<string>\",\n \"children\": \"<array>\",\n \"sim_hash_dir_names\": \"<string>\",\n \"lang_extensions\": {}\n },\n \"rank_threshold\": 123,\n \"category\": \"<string>\",\n \"query_limit\": 123,\n \"recursive_threshold\": 123,\n \"min_accepted_score\": 123\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/scanning/hfh/scan")
.header("Content-Type", "application/json")
.body("{\n \"root\": {\n \"path_id\": \"<string>\",\n \"sim_hash_names\": \"<string>\",\n \"sim_hash_content\": \"<string>\",\n \"children\": \"<array>\",\n \"sim_hash_dir_names\": \"<string>\",\n \"lang_extensions\": {}\n },\n \"rank_threshold\": 123,\n \"category\": \"<string>\",\n \"query_limit\": 123,\n \"recursive_threshold\": 123,\n \"min_accepted_score\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/scanning/hfh/scan")
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 \"root\": {\n \"path_id\": \"<string>\",\n \"sim_hash_names\": \"<string>\",\n \"sim_hash_content\": \"<string>\",\n \"children\": \"<array>\",\n \"sim_hash_dir_names\": \"<string>\",\n \"lang_extensions\": {}\n },\n \"rank_threshold\": 123,\n \"category\": \"<string>\",\n \"query_limit\": 123,\n \"recursive_threshold\": 123,\n \"min_accepted_score\": 123\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"path_id": "<string>",
"components": [
{
"purl": "<string>",
"name": "<string>",
"vendor": "<string>",
"versions": [
{
"version": "<string>",
"score": 123,
"licenses": [
{
"name": "<string>",
"spdx_id": "<string>",
"is_spdx_approved": true,
"url": "<string>"
}
]
}
],
"rank": 123,
"order": 123
}
]
}
],
"status": {
"status": "UNSPECIFIED",
"message": "<string>",
"db": {
"schema_version": "<string>",
"created_at": "<string>"
},
"server": {
"version": "<string>"
}
}
}"<string>"{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Scanning
Scan the given folder request looking for matches
POST
/
v2
/
scanning
/
hfh
/
scan
Scan the given folder request looking for matches
curl --request POST \
--url https://api.example.com/v2/scanning/hfh/scan \
--header 'Content-Type: application/json' \
--data '
{
"root": {
"path_id": "<string>",
"sim_hash_names": "<string>",
"sim_hash_content": "<string>",
"children": "<array>",
"sim_hash_dir_names": "<string>",
"lang_extensions": {}
},
"rank_threshold": 123,
"category": "<string>",
"query_limit": 123,
"recursive_threshold": 123,
"min_accepted_score": 123
}
'import requests
url = "https://api.example.com/v2/scanning/hfh/scan"
payload = {
"root": {
"path_id": "<string>",
"sim_hash_names": "<string>",
"sim_hash_content": "<string>",
"children": "<array>",
"sim_hash_dir_names": "<string>",
"lang_extensions": {}
},
"rank_threshold": 123,
"category": "<string>",
"query_limit": 123,
"recursive_threshold": 123,
"min_accepted_score": 123
}
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({
root: {
path_id: '<string>',
sim_hash_names: '<string>',
sim_hash_content: '<string>',
children: '<array>',
sim_hash_dir_names: '<string>',
lang_extensions: {}
},
rank_threshold: 123,
category: '<string>',
query_limit: 123,
recursive_threshold: 123,
min_accepted_score: 123
})
};
fetch('https://api.example.com/v2/scanning/hfh/scan', 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/scanning/hfh/scan",
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([
'root' => [
'path_id' => '<string>',
'sim_hash_names' => '<string>',
'sim_hash_content' => '<string>',
'children' => '<array>',
'sim_hash_dir_names' => '<string>',
'lang_extensions' => [
]
],
'rank_threshold' => 123,
'category' => '<string>',
'query_limit' => 123,
'recursive_threshold' => 123,
'min_accepted_score' => 123
]),
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/scanning/hfh/scan"
payload := strings.NewReader("{\n \"root\": {\n \"path_id\": \"<string>\",\n \"sim_hash_names\": \"<string>\",\n \"sim_hash_content\": \"<string>\",\n \"children\": \"<array>\",\n \"sim_hash_dir_names\": \"<string>\",\n \"lang_extensions\": {}\n },\n \"rank_threshold\": 123,\n \"category\": \"<string>\",\n \"query_limit\": 123,\n \"recursive_threshold\": 123,\n \"min_accepted_score\": 123\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/scanning/hfh/scan")
.header("Content-Type", "application/json")
.body("{\n \"root\": {\n \"path_id\": \"<string>\",\n \"sim_hash_names\": \"<string>\",\n \"sim_hash_content\": \"<string>\",\n \"children\": \"<array>\",\n \"sim_hash_dir_names\": \"<string>\",\n \"lang_extensions\": {}\n },\n \"rank_threshold\": 123,\n \"category\": \"<string>\",\n \"query_limit\": 123,\n \"recursive_threshold\": 123,\n \"min_accepted_score\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v2/scanning/hfh/scan")
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 \"root\": {\n \"path_id\": \"<string>\",\n \"sim_hash_names\": \"<string>\",\n \"sim_hash_content\": \"<string>\",\n \"children\": \"<array>\",\n \"sim_hash_dir_names\": \"<string>\",\n \"lang_extensions\": {}\n },\n \"rank_threshold\": 123,\n \"category\": \"<string>\",\n \"query_limit\": 123,\n \"recursive_threshold\": 123,\n \"min_accepted_score\": 123\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"path_id": "<string>",
"components": [
{
"purl": "<string>",
"name": "<string>",
"vendor": "<string>",
"versions": [
{
"version": "<string>",
"score": 123,
"licenses": [
{
"name": "<string>",
"spdx_id": "<string>",
"is_spdx_approved": true,
"url": "<string>"
}
]
}
],
"rank": 123,
"order": 123
}
]
}
],
"status": {
"status": "UNSPECIFIED",
"message": "<string>",
"db": {
"schema_version": "<string>",
"created_at": "<string>"
},
"server": {
"version": "<string>"
}
}
}"<string>"{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Body
application/json
Show child attributes
Show child attributes
Get results with rank below this threshold (e.g i only want to see results from rank 5 and below). Lower rank means better quality.
⌘I