Dependencies

Get Dependency Version Code Roots

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
namestringRequired
versionstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/dependencies/{name}/versions/{version}/code_roots

Get Global Dependencies

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/dependencies

Get Global Dependencies

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/dependencies

Get Dependency Versions

get

This endpoint is now deprecated.

Please use /api/dependencies/{package_name}/usage for the "Versions" tab in the Global Dependencies Details view.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/dependencies/{package_name}/versions

Get Dependency Versions

post

This endpoint is now deprecated.

Please use /api/dependencies/{package_name}/usage for the "Versions" tab in the Global Dependencies Details view.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Bodyany of[]
or
or
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/dependencies/{package_name}/versions

Generate Sbom

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful Response

application/json

Represents a CycloneDX SBOM (Software Bill of Materials) format.

See: https://cyclonedx.org/docs/1.6/json/

bomFormatstringRequired
serialNumberany ofOptional
stringOptional
or
nullOptional
specVersionstringOptionalDefault: 1.6
versionany ofOptional
integerOptional
or
nullOptional
post
/api/dependencies/global_sbom

Get Dependency Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
chevron-right
200

Successful Response

application/json
get
/api/dependencies/_terms

Get Dependency Package Modules

get

Get all modules that use a specific package.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Body
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/dependencies/{package_name}/modules

Get Dependency Package Modules

post

Get all modules that use a specific package.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Body
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
post
/api/dependencies/{package_name}/modules

Get Dependency Package Modules Terms

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Responses
chevron-right
200

Successful Response

application/json
get
/api/dependencies/{package_name}/modules/_terms

Get Dependency Package Deployments

get

Get all deployments/services that are running a specific package.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/dependencies/{package_name}/deployments

Get Dependency Summary

get

Get a summary card for a specific dependency package version, optionally scoped to a service.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
versionstringRequired
package_namestringRequired
Query parameters
service_idany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json

Summary card for a specific version of a dependency at a code root.

Includes:

  • Temporal data (release_date, first_seen)
  • Findings broken down by PRIORITY (urgent/planned/deferred)
package_namestringRequired
repository_urlany ofOptional
stringOptional
or
nullOptional
module_countintegerRequired
licenseany ofRequired
or
nullOptional
package_ecosystemany ofRequired
string · enumOptional

An enumeration of supported package ecosystems.

An ecosystem is defined as a repository of packages such as PyPi or Maven Central. This is distinct from a package manager (e.g. yarn, conda), which is a tool that can interact with one or more ecosystems.

Possible values:
or
nullOptional
artifact_sourceany ofRequired
stringOptional
or
nullOptional
current_findings_countintegerOptionalDefault: 0
previous_month_findings_countintegerOptionalDefault: 0
findings_change_percentageany ofRequired
numberOptional
or
nullOptional
remediations_countintegerOptionalDefault: 0
services_countintegerOptionalDefault: 0
deployments_countintegerOptionalDefault: 0
found_in_codebooleanOptionalDefault: false
found_at_runtimebooleanOptionalDefault: false
release_dateany ofOptional
string · date-timeOptional
or
nullOptional
first_seenany ofOptional
string · date-timeOptional
or
nullOptional
urgent_findings_countintegerOptionalDefault: 0
planned_findings_countintegerOptionalDefault: 0
deferred_findings_countintegerOptionalDefault: 0
get
/api/dependencies/code_roots/{code_root_id}/{package_name}/versions/{version}/summary

Get Package Summary

get

Get a summary card for all versions of a dependency package (not scoped to a specific version or service).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Responses
chevron-right
200

Successful Response

application/json

Summary card for all versions of a dependency across the organization.

Includes:

  • Version count
  • Findings broken down by SEVERITY (critical/high/medium/low)
package_namestringRequired
repository_urlany ofOptional
stringOptional
or
nullOptional
module_countintegerRequired
licenseany ofRequired
or
nullOptional
package_ecosystemany ofRequired
string · enumOptional

An enumeration of supported package ecosystems.

An ecosystem is defined as a repository of packages such as PyPi or Maven Central. This is distinct from a package manager (e.g. yarn, conda), which is a tool that can interact with one or more ecosystems.

Possible values:
or
nullOptional
artifact_sourceany ofRequired
stringOptional
or
nullOptional
current_findings_countintegerOptionalDefault: 0
previous_month_findings_countintegerOptionalDefault: 0
findings_change_percentageany ofRequired
numberOptional
or
nullOptional
remediations_countintegerOptionalDefault: 0
services_countintegerOptionalDefault: 0
deployments_countintegerOptionalDefault: 0
found_in_codebooleanOptionalDefault: false
found_at_runtimebooleanOptionalDefault: false
version_countintegerOptionalDefault: 0
critical_findings_countintegerOptionalDefault: 0
high_findings_countintegerOptionalDefault: 0
medium_findings_countintegerOptionalDefault: 0
low_findings_countintegerOptionalDefault: 0
get
/api/dependencies/{package_name}/summary

Get Dependency Hygiene Summary

get

Get OSSF Scorecard hygiene scores for a dependency package. Returns None if no OSSF report is available.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
versionstringRequired
package_namestringRequired
Responses
chevron-right
200

Successful Response

application/json
or
nullOptional
get
/api/dependencies/code_roots/{code_root_id}/{package_name}/versions/{version}/hygiene_summary

Get Global Dependency Hygiene Summary

get

Get OSSF Scorecard hygiene scores for a dependency package. Returns None if no OSSF report is available.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Responses
chevron-right
200

Successful Response

application/json
or
nullOptional
get
/api/dependencies/{package_name}/hygiene_summary

Get Dependency Activity Timeline

get

Get a timeline of version changes for a dependency in a code root.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
code_root_idintegerRequired
package_namestringRequired
versionstringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json

A timeline of activity items for a dependency package.

totalintegerRequired
get
/api/dependencies/code_roots/{code_root_id}/{package_name}/versions/{version}/activity_timeline

Get Global Dependency Activity Timeline

get

Get a global timeline of version activity for a dependency package.

Not scoped to a specific code root or version. Shows all versions of the package across code roots with commit and author information.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json

A timeline of activity items for a dependency package.

totalintegerRequired
get
/api/dependencies/{package_name}/activity_timeline

Get Version Modules

get

Given a specific Package Name, index and return a list of all modules that use it, along with the version they use.

A module is a package within a code root (application path).

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Responses
chevron-right
200

Successful Response

application/json

A list of modules using a package.

totalintegerRequired
get
/api/dependencies/{package_name}/modules_list

Get Dependency Version Usage Summary

get

Get usage summary of all versions of a dependency package across code roots. Shows how many code roots are using each version of the package, along with findings counts, release date, and when the version was first seen.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
package_namestringRequired
Query parameters
pageintegerOptionalDefault: 0
limitinteger · min: 1OptionalDefault: 100
orderany ofOptional
stringOptional
or
nullOptional
ordersany ofOptional
string[]Optional
or
nullOptional
directionany ofOptional
stringOptional
or
nullOptional
searchany ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
totalintegerRequired
pagesintegerRequired
page_sizeintegerRequired
page_numberintegerRequired
get
/api/dependencies/{package_name}/usage

Last updated

Was this helpful?