dependency-graph

Check license compliance for packages

Changed on

Checks whether packages identified by the supplied package URLs (PURLs) are allowed by the repository's license compliance policy.

For requests made on behalf of a user, that user must have write access to the repository or the "View repository license policy" permission. OAuth apps and classic personal access tokens require the repo scope.

post/repos/{owner}/{repo}/license-compliance/package-checks

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/license-compliance/package-checks
  • Auth: none declared

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

Request body

purlsstring[] required

Up to 40 package URLs to check against the license compliance policy. Duplicate package URLs count toward the limit but are checked once.

Response

Package license compliance results.

purlsobject required

Changes