Sign in

v1

latestOpenAPI 3.0.32026-07-22238629559.2 KB
SupplyChain2Service

List dependencies

Returns all (or filtered) dependencies for a deployment using pagination

get/api/sca/deployments/{deploymentId}/dependencies

Path parameters

deploymentIdstring int64 required

Deployment ID (numeric). Example: 123. Can be found at /deployments, or in your Settings in the web UI.

Query parameters

dependencyFilter.namestring

Deprecated - use package_filters instead. Filter by dependency name (e.g. lodash).

dependencyFilter.versionstring

Deprecated - use package_filters instead. Filter by dependency version (e.g. 1.0.1).

dependencyFilter.repositoryIdinteger[]

Repository IDs (numeric) to filter by. Omit if the endpoint has Repository ID as a path parameter. Use Projects endpoints to retrieve Repository IDs.

dependencyFilter.transitivitystring[]

Filter by transitivity.

dependencyFilter.ecosystemstring[]

Filter by ecosystem (e.g. npm, pypi, etc).

dependencyFilter.lockfilePathstring

Filter by path to the lockfile (e.g. foo/bar/package-lock.json).

dependencyFilter.licensePolicySettingsstring[]

Filter by license policy setting outcome.

dependencyFilter.licensestring[]

Filter by license (e.g. MIT).

cursorstring int64

Cursor to paginate through the dependencies. Provide a cursor value from the response to retrieve the next page.

pageSizeinteger

Number of dependencies per page.

Example:1000

Response

OK

hasMoreboolean

True if there are more dependencies to get.

cursorstring int64

Pass to next request to get next page of results.

Example response

{
  "dependencies": [
    {
      "id": "1",
      "name": "dependency1",
      "version": "1.0.0"
    },
    {
      "id": "2",
      "name": "dependency2",
      "version": "2.0.0"
    }
  ]
}