Skip to main content
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
}
'
{
  "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>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.scanoss.com/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json
root
Child node from the folder structure · object
rank_threshold
integer<int32>

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.

category
string
query_limit
integer<int32>
recursive_threshold
number<float>
min_accepted_score
number<float>

Response

A successful response.

results
Result item, link a path with a list of components · object[]
status
object

Detailed response details.