Dependencies

Get Dependency Version Code Roots

get

Authorizations

HTTPBearer

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

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/dependencies/{name}/versions/{version}/code_roots

HTTPcURLJavaScriptPython

GET /api/dependencies/{name}/versions/{version}/code_roots HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "code_root_id": 1,
      "code_root": "text",
      "repository_id": "text",
      "repository_name": "text",
      "repository_org": "text",
      "dependencies_count": 1,
      "dependencies_findings_count": 1,
      "latest_activity": "2025-12-14T11:02:45.916Z",
      "technologies": [
        "text"
      ],
      "linked_services": [
        {
          "service_id": 1,
          "name": "text",
          "application_params": "text",
          "application": "text"
        }
      ],
      "source": "text",
      "language": "text",
      "language_version": "text"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Global Dependencies

get

Authorizations

HTTPBearer

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[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/dependencies

HTTPcURLJavaScriptPython

GET /api/dependencies HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "package_name": "text",
      "version_count": 1,
      "raw_license": "text",
      "normalized_license": {
        "operand": "text",
        "licenses": [
          "text"
        ]
      },
      "license_allowed": "Approved",
      "hygiene_score": 1,
      "total_modules": 1,
      "first_party": true,
      "third_party": true,
      "direct": true,
      "transitive": true,
      "open_source": true,
      "vendor": true,
      "unmaintained": true,
      "unpinned": true,
      "package_ecosystem": "default",
      "is_reachable": true
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Global Dependencies

post

Authorizations

HTTPBearer

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[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/dependencies

HTTPcURLJavaScriptPython

POST /api/dependencies HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "package_name": "text",
      "version_count": 1,
      "raw_license": "text",
      "normalized_license": {
        "operand": "text",
        "licenses": [
          "text"
        ]
      },
      "license_allowed": "Approved",
      "hygiene_score": 1,
      "total_modules": 1,
      "first_party": true,
      "third_party": true,
      "direct": true,
      "transitive": true,
      "open_source": true,
      "vendor": true,
      "unmaintained": true,
      "unpinned": true,
      "package_ecosystem": "default",
      "is_reachable": true
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Dependency Versions

get

Authorizations

HTTPBearer

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[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/dependencies/{package_name}/versions

HTTPcURLJavaScriptPython

GET /api/dependencies/{package_name}/versions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "version": "text",
      "critical_findings": 1,
      "high_findings": 1,
      "medium_findings": 1,
      "low_findings": 1,
      "affected_modules": 1,
      "release_date": "2025-12-14T11:02:45.916Z",
      "first_seen": "2025-12-14T11:02:45.916Z"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Dependency Versions

post

Authorizations

HTTPBearer

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[]

application/json

or

or

Responses

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

post

/api/dependencies/{package_name}/versions

HTTPcURLJavaScriptPython

POST /api/dependencies/{package_name}/versions HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

[
  {
    "name": "text",
    "lt": 1,
    "lte": 1,
    "gt": 1,
    "gte": 1,
    "equals": 1
  }
]

{
  "items": [
    {
      "version": "text",
      "critical_findings": 1,
      "high_findings": 1,
      "medium_findings": 1,
      "low_findings": 1,
      "affected_modules": 1,
      "release_date": "2025-12-14T11:02:45.916Z",
      "first_seen": "2025-12-14T11:02:45.916Z"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Generate Sbom

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

post

/api/dependencies/global_sbom

HTTPcURLJavaScriptPython

POST /api/dependencies/global_sbom HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "bomFormat": "text",
  "components": [
    {
      "type": "application",
      "name": "text",
      "version": "text",
      "bom-ref": "text",
      "purl": "text",
      "group": "text",
      "properties": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "components": [
        {
          "type": "application",
          "name": "text",
          "version": "text",
          "bom-ref": "text",
          "purl": "text",
          "group": "text",
          "properties": [
            {
              "name": "text",
              "value": "text"
            }
          ],
          "components": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ],
  "dependencies": [
    {
      "ref": "text",
      "dependsOn": [
        "text"
      ]
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "serialNumber": "text",
  "specVersion": "1.6",
  "version": 1
}

Get Dependency Terms

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

404

Not found

get

/api/dependencies/_terms

HTTPcURLJavaScriptPython

GET /api/dependencies/_terms HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "terms": [
    {
      "name": "text",
      "lazy_load": false,
      "type": "Int",
      "terms": [
        {
          "lowerBound": 1,
          "upperBound": 1,
          "count": 1
        }
      ]
    }
  ]
}

Get Dependency Package Modules

get

Get all modules that use a specific package.

Authorizations

HTTPBearer

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

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/dependencies/{package_name}/modules

HTTPcURLJavaScriptPython

GET /api/dependencies/{package_name}/modules HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "code_root_id": 1,
      "code_root": "text",
      "repository_id": "text",
      "dependencies_count": 1,
      "remediations_count": 1,
      "latest_activity": "2025-12-14T11:02:45.916Z",
      "technologies": [
        "text"
      ],
      "linked_services": [
        {
          "service_id": 1,
          "name": "text",
          "application_params": "text",
          "application": "text"
        }
      ],
      "source": "text",
      "finding_counts": {
        "total": 1,
        "critical": 1,
        "high": 1,
        "medium": 1,
        "low": 1
      },
      "tech_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "security_leads": [
        {
          "id": 1,
          "name": "text",
          "email": "text",
          "alternate_emails": [
            "text"
          ],
          "is_hidden": true
        }
      ],
      "language": "text",
      "language_version": "text",
      "dependency_version": "text",
      "dependency_introduced": "2025-12-14T11:02:45.916Z"
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Dependency Package Deployments

get

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

Authorizations

HTTPBearer

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

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/dependencies/{package_name}/deployments

HTTPcURLJavaScriptPython

GET /api/dependencies/{package_name}/deployments HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "service_id": 1,
      "service_name": "text",
      "resource": "text",
      "changeset": "text",
      "container_tag": "text",
      "environment": "text",
      "findings_count": 1,
      "vuln_count": 1,
      "secret_count": 1,
      "critical_findings_count": 1,
      "high_findings_count": 1,
      "medium_findings_count": 1,
      "low_findings_count": 1,
      "info_findings_count": 1,
      "accessibility": [
        "text"
      ]
    }
  ],
  "total": 1,
  "pages": 1,
  "page_size": 1,
  "page_number": 1
}

Get Dependency Summary

get

Get a summary of a specific dependency package version.

Returns metrics about vulnerabilities, services, deployments, and reachability. Returns empty/zero values if data is not available.

Authorizations

HTTPBearer

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

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

/api/dependencies/code_roots/{code_root_id}/dependencies/{package_name}/versions/{version}/summary

HTTPcURLJavaScriptPython

GET /api/dependencies/code_roots/{code_root_id}/dependencies/{package_name}/versions/{version}/summary HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "module_count": 1,
  "license": {
    "operand": "text",
    "licenses": [
      "text"
    ]
  },
  "package_ecosystem": "default",
  "current_findings_count": 0,
  "previous_month_findings_count": 0,
  "findings_change_percentage": 1,
  "urgent_findings_count": 0,
  "planned_findings_count": 0,
  "deferred_findings_count": 0,
  "remediations_count": 0,
  "services_count": 0,
  "deployments_count": 0,
  "found_in_code": false,
  "found_at_runtime": false
}

Get Dependency Hygiene Summary

get

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

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

code_root_idintegerRequired

versionstringRequired

package_namestringRequired

Responses

200

Successful Response

application/json

Responseany of

or

nullOptional

404

Not found

422

Validation Error

application/json

get

/api/dependencies/code_roots/{code_root_id}/dependencies/{package_name}/versions/{version}/hygiene_summary

HTTPcURLJavaScriptPython

GET /api/dependencies/code_roots/{code_root_id}/dependencies/{package_name}/versions/{version}/hygiene_summary HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "overall": 1,
  "code": {
    "pinned_dependencies": 1,
    "code_review": 1,
    "branch_protection": 1,
    "binary_artifacts": 1
  },
  "build": {
    "packaging": 1,
    "token_permissions": 1,
    "signed_releases": 1,
    "dangerous_workflows": 1
  },
  "maintenance": {
    "maintained": 1,
    "cii_best_practices": 1,
    "license": 1,
    "security_policy": 1
  },
  "testing": {
    "fuzzing": 1,
    "sast": 1
  },
  "vulnerabilities": {
    "vulnerabilities": 1
  }
}

Get Dependency Activity Timeline

get

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

Shows all versions of the package with commit and author information. Returns empty list if no versions found.

Authorizations

HTTPBearer

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

200

Successful Response

application/json

404

Not found

422

Validation Error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/dependencies/code_roots/{code_root_id}/dependencies/{package_name}/versions/{version}/activity_timeline HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "version": "text",
      "author_email": "text",
      "author_name": "text",
      "commit_sha": "text",
      "commit_url": "text",
      "timestamp": "2025-12-14T11:02:45.916Z",
      "is_current": true
    }
  ],
  "total": 1
}