Packages

Show details of a specific package.

Changed on

Show details of a specific package

get/v1/packages/{package_platform}/{package_name}

Request

  • Base URL
    https://api.tidelift.com/external-api
  • Auth
    HTTP bearer

Path parameters

package_platformstring required
Example:rubygems

The platform of the package.

package_namestring required
Example:rails

The name of the package to look up.

Response

Details of the package

platformstring required

The package manager platform, all lowercase.

namestring required

The canonical name of the package (may be adjusted for casing or hyphen vs underscore for example)

purlstring required

An identifier for the package following the package URL (purl) specification

descriptionstring nullable required

Package description taken from the upstream package manager data

tidelift_recommendation'recommended' | 'not_recommended' | 'caution_advised' | 'neutral' | 'not_assessed' nullable required
tidelift_recommendation_reasonsstring[]
last_changed_onstring date nullable required

When the package record last was updated by new information

security_policy_urlstring nullable required

If available, a url for the package's upstream security reporting policy

versioning_scheme'maven' | 'pep440' | 'osgi' | 'semver' | 'calver' | 'other' required

The version numbering rules that the package intends to use; Tidelift may add new possible values for this field over time

contributors_countinteger nullable required

Number of contributors to the upstream source repository, if available

package_manager_urlstring nullable

Link to this package on the package manager website

sdlc_policystring nullable required

If available, a URL where the project explains its software development lifecycle policy (for example, which release streams are still receiving security updates)

sdlc_evidencestring nullable required

If available, a URL that may help figure out the project's software development lifecycle policies

is_liftedboolean required

Whether Tidelift partners with the maintainers of this package

Example response

{
  "license": {
    "expression": "GPL-3.0 OR MIT"
  }
}

Changes

    • warning

      added the new has organizational backing enum value to the / response property for the response status

    • info

      added the non-success response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • breaking

      the response property /////////// became nullable for the status

    • breaking

      the response property /////////// became nullable for the status

    • breaking

      the response property /////////// became nullable for the status

    • breaking

      the response property /////////// became nullable for the status

    • breaking

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

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • warning

      removed the optional property /////////// from the response with the status

    • info

      removed from the ////// response property oneOf list for the response status

    • info

      added the required property to the response with the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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