Packages

List packages

get/packages

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

Changed in 5 of the 6 revisions of this API.848

  • v136d7585ff64c113See the full diff
    • the packages/items/health response's property type/format changed from integer null/ to object/ for status 200

      response-property-type-changed

    • added the new archived enum value to the packages/items/lifecycle response property for the response status 200

      response-property-enum-value-added

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

      request-parameter-enum-value-added

    • added the required property packages/items/health/label to the response with the 200 status

      response-required-property-added

    • added the required property packages/items/health/score to the response with the 200 status

      response-required-property-added

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

      response-property-list-of-types-narrowed

  • v108763340c7f521See the full diff
    • the response property packages/items/stewards/oneOf[subschema #1]/items/name became nullable for the status 200

      response-property-became-nullable

    • the response property packages/items/stewards/oneOf[subschema #1]/items/name became optional for the status 200

      response-property-became-optional

    • added the optional property packages/items/stewardshipId to the response with the 200 status

      response-optional-property-added

  • v15ade51496c1111See the full diff
    • removed the optional property packages/items/steward from the response with the 200 status

      response-optional-property-removed

    • added the optional property packages/items/stewards to the response with the 200 status

      response-optional-property-added

  • v1f6ec2792f131522See the full diff
    • removed the enum value archived from the query request parameter lifecycle

      request-parameter-enum-value-removed

    • the response property packages/items/health became nullable for the status 200

      response-property-became-nullable

    • the packages/items/health response's property type/format changed from object/ to integer null/ for status 200

      response-property-type-changed

    • removed the required property packages/items/health/label from the response with the 200 status

      response-required-property-removed

    • removed the required property packages/items/health/score from the response with the 200 status

      response-required-property-removed

    • removed the optional property packages/items/stewards from the response with the 200 status

      response-optional-property-removed

    • removed the optional property packages/items/stewardshipId from the response with the 200 status

      response-optional-property-removed

    • added the optional property packages/items/steward to the response with the 200 status

      response-optional-property-added

    • removed the archived enum value from the packages/items/lifecycle response property for the response status 200

      response-property-enum-value-removed