LIlinuxfoundation
Packages

List packages

Changed on
get/packages

Request

  • Base URL
    https://cm.lfx.dev/api/v1
  • URL
    https://cm.lfx.dev/api/v1/packages
  • Auth
    HTTP bearer

Query parameters

pageinteger
pageSizeinteger
ecosystemstring
lifecycle'active' | 'stable' | 'declining' | 'abandoned' | 'archived'
busFactor1Onlyboolean

Return only packages with bus factor = 1.

staleOnlyboolean

Return only packages with no release in >= 18 months.

unstewardedOnlyboolean

Return only packages with stewardship = unassigned.

sortBy'name' | 'health' | 'impact' | 'openVulns'
sortDir'asc' | 'desc'

Response

Paginated list of packages.

pageinteger required
pageSizeinteger required
totalinteger required

Example response

{
  "packages": [
    {
      "purl": "pkg:npm/lodash",
      "name": "lodash",
      "ecosystem": "npm",
      "health": {
        "score": 18,
        "label": "critical"
      },
      "impact": 71,
      "maintainerBusFactor": 1,
      "openVulns": {
        "high": 1
      },
      "stewardshipId": "42",
      "stewards": [
        {
          "userId": "abc123",
          "username": "jrodriguez",
          "displayName": "Jonathan R."
        }
      ]
    }
  ]
}

Changes

  • v136d7585ff64cRevision changes
    • breaking

      the // response's property type changed from integer null to object for status

    • warning

      added the new archived enum value to the // response property for the response status

    • info

      added the new enum value archived to the query request parameter lifecycle

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

  • v13272cbfaa72bRevision changes
    • info

      response property packages/items/stewards list-of-types was narrowed by removing types null from media type application/json of response 200