Skip to main content
GET
/
scan
/
{scan_id}
/
dependencies
Get Dependencies for Scan
curl --request GET \
  --url https://www.corgea.app/api/v1/scan/{scan_id}/dependencies \
  --header 'CORGEA-TOKEN: <api-key>'
{
  "status": "ok",
  "page": 123,
  "total_pages": 123,
  "total_dependencies": 123,
  "dependencies": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "version": "<string>",
      "type": "<string>",
      "purl": "<string>",
      "path": "<string>",
      "licenses": [
        "<string>"
      ],
      "properties": [
        "<unknown>"
      ],
      "is_direct": true,
      "parent_id": "<string>",
      "source_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "scan": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "branch": "<string>",
        "project": "<string>"
      }
    }
  ]
}

Authorizations

​
CORGEA-TOKEN
string
header
required

API key for authentication

Path Parameters

​
scan_id
string<uuid>
required

The ID of the scan

Query Parameters

​
page
integer
default:1

The page number for pagination

​
page_size
integer
default:20

The number of results per page

Required range: x <= 50
​
name
string

Filter by dependency name (partial match)

​
version
string

Filter by dependency version

​
type
string

Filter by dependency ecosystem or package type

​
path
string

Filter by file path (partial match)

​
purl
string

Filter by package URL (partial match)

​
license
string

Filter by license

​
dep_type
enum<string>
default:all

Filter by dependency relationship type

Available options:
direct,
transitive,
all
​
search
string

Search across dependency name, version, and package URL

​
sort_by
enum<string>

Sort results by field (prefix with '-' for descending order)

Available options:
name,
-name,
version,
-version,
type,
-type,
created_at,
-created_at

Response

Get Dependencies for Scan retrieved successfully

​
status
string
Example:

"ok"

​
page
integer
​
total_pages
integer
​
total_dependencies
integer
​
dependencies
object[]