Dependency submission
Use the REST API to submit dependencies.
About dependency submissions
Note: The ability to use the REST API for dependency submission is currently in public beta and subject to change.
You can use the REST API to submit dependencies for a project. This enables you to add dependencies, such as those resolved when software is compiled or built, to GitHub's dependency graph feature, providing a more complete picture of all of your project's dependencies.
The dependency graph shows any dependencies you submit using the API in addition to any dependencies that are identified from manifest or lock files in the repository (for example, a package-lock.json
file in a JavaScript project). For more information about viewing the dependency graph, see "Exploring the dependencies of a repository."
Submitted dependencies will receive Dependabot alerts and Dependabot security updates for any known vulnerabilities. You will only get Dependabot alerts for dependencies that are from one of the supported ecosystems of the GitHub Advisory Database. Submitted dependencies will not be surfaced in dependency review or your organization's dependency insights.
You can submit dependencies in the form of a snapshot. A snapshot is a set of dependencies associated with a commit SHA and other metadata, that reflects the current state of your repository for a commit. You can choose to use pre-made actions or create your own actions to submit your dependencies in the required format each time your project is built. For more information, see "Using the Dependency submission API."
You can submit multiple sets of dependencies to be included in your dependency graph. The REST API uses the job.correlator
property and the detector.name
category of the snapshot to ensure the latest submissions for each workflow get shown. The correlator
property itself is the primary field you will use to keep independent submissions distinct. An example correlator
could be a simple combination of two variables available in actions runs: <GITHUB_WORKFLOW> <GITHUB_JOB>
.
Create a snapshot of dependencies for a repository
Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the repo
scope to use this endpoint for a repository that the requesting user has access to.
Parameters
Headers | ||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name, Type, Description | ||||||||||||||||||||||||||||||||||||
accept stringSetting to | ||||||||||||||||||||||||||||||||||||
Path parameters | ||||||||||||||||||||||||||||||||||||
Name, Type, Description | ||||||||||||||||||||||||||||||||||||
owner stringRequiredThe account owner of the repository. The name is not case sensitive. | ||||||||||||||||||||||||||||||||||||
repo stringRequiredThe name of the repository. The name is not case sensitive. | ||||||||||||||||||||||||||||||||||||
Body parameters | ||||||||||||||||||||||||||||||||||||
Name, Type, Description | ||||||||||||||||||||||||||||||||||||
version integerRequiredThe version of the repository snapshot submission. | ||||||||||||||||||||||||||||||||||||
job objectRequired | ||||||||||||||||||||||||||||||||||||
Properties of |
Name, Type, Description |
---|
id stringRequiredThe external ID of the job. |
correlator stringRequiredCorrelator provides a key that is used to group snapshots submitted over time. Only the "latest" submitted snapshot for a given combination of |
html_url stringThe url for the job. |
sha
stringRequiredThe commit SHA associated with this dependency snapshot. Maximum length: 40 characters.
ref
stringRequiredThe repository branch that triggered this snapshot.
detector
objectRequiredA description of the detector used.
Properties of detector
Name, Type, Description |
---|
name stringRequiredThe name of the detector used. |
version stringRequiredThe version of the detector used. |
url stringRequiredThe url of the detector used. |
metadata
objectUser-defined metadata to store domain-specific information limited to 8 keys with scalar values.
manifests
objectA collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.
Properties of manifests
Name, Type, Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
key objectA user-defined key to represent an item in | ||||||||||||||||||||||||||||||
Properties of |
Name, Type, Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name stringRequiredThe name of the manifest. | |||||||||||||||
file object | |||||||||||||||
Properties of |
Name, Type, Description |
---|
source_location stringThe path of the manifest file relative to the root of the Git repository. |
metadata
objectUser-defined metadata to store domain-specific information limited to 8 keys with scalar values.
resolved
objectA collection of resolved package dependencies.
Properties of resolved
Name, Type, Description | |||||||||
---|---|---|---|---|---|---|---|---|---|
key objectA user-defined key to represent an item in | |||||||||
Properties of |
Name, Type, Description |
---|
package_url stringPackage-url (PURL) of dependency. See https://github.com/package-url/purl-spec for more details. |
metadata objectUser-defined metadata to store domain-specific information limited to 8 keys with scalar values. |
relationship stringA notation of whether a dependency is requested directly by this manifest or is a dependency of another dependency. Can be one of: |
scope stringA notation of whether the dependency is required for the primary build artifact (runtime) or is only used for development. Future versions of this specification may allow for more granular scopes. Can be one of: |
dependencies array of stringsArray of package-url (PURLs) of direct child dependencies. |
scanned
stringRequiredThe time at which the snapshot was scanned.
HTTP response status codes
Status code | Description |
---|---|
201 | Created |
Code samples
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/OWNER/REPO/dependency-graph/snapshots \
-d '{"version":0,"sha":"ce587453ced02b1526dfb4cb910479d431683101","ref":"refs/heads/main","job":{"correlator":"yourworkflowname_youractionname","id":"yourrunid"},"detector":{"name":"octo-detector","version":"0.0.1","url":"https://github.com/octo-org/octo-repo"},"scanned":"2022-06-14T20:25:00Z","manifests":{"package-lock.json":{"name":"package-lock.json","file":{"source_location":"src/package-lock.json"},"resolved":{"@actions/core":{"package_url":"pkg:/npm/%40actions/core@1.1.9","dependencies":["@actions/http-client"]},"@actions/http-client":{"package_url":"pkg:/npm/%40actions/http-client@1.0.7","dependencies":["tunnel"]},"tunnel":{"package_url":"pkg:/npm/tunnel@0.0.6"}}}}}'
Response
Status: 201
{
"id": 12345,
"created_at": "2018-05-04T01:14:52Z",
"message": "Dependency results for the repo have been successfully updated.",
"result": "SUCCESS"
}