Create a snapshot of dependencies for a repository

POST

/repos/{owner}/{repo}/dependency-graph/snapshots

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/repos///dependency-graph/snapshots' \
--header 'Content-Type: application/json' \
--data-raw '{
    "detector": {
        "name": "docker buildtime detector",
        "url": "http://example.com/docker-buildtimer-detector",
        "version": "1.0.0"
    },
    "job": {
        "correlator": "yourworkflowname_yourjobname",
        "html_url": "http://example.com/build",
        "id": "5622a2b0-63f6-4732-8c34-a1ab27e102a11"
    },
    "manifests": {
        "property1": {
            "file": {
                "source_location": "/src/build/package-lock.json"
            },
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "name": "package-lock.json",
            "resolved": {
                "property1": {
                    "dependencies": "@actions/http-client",
                    "metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "package_url": "pkg:/npm/%40actions/http-client@1.0.11",
                    "relationship": "direct",
                    "scope": "runtime"
                },
                "property2": {
                    "dependencies": "@actions/http-client",
                    "metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "package_url": "pkg:/npm/%40actions/http-client@1.0.11",
                    "relationship": "direct",
                    "scope": "runtime"
                }
            }
        },
        "property2": {
            "file": {
                "source_location": "/src/build/package-lock.json"
            },
            "metadata": {
                "property1": "string",
                "property2": "string"
            },
            "name": "package-lock.json",
            "resolved": {
                "property1": {
                    "dependencies": "@actions/http-client",
                    "metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "package_url": "pkg:/npm/%40actions/http-client@1.0.11",
                    "relationship": "direct",
                    "scope": "runtime"
                },
                "property2": {
                    "dependencies": "@actions/http-client",
                    "metadata": {
                        "property1": "string",
                        "property2": "string"
                    },
                    "package_url": "pkg:/npm/%40actions/http-client@1.0.11",
                    "relationship": "direct",
                    "scope": "runtime"
                }
            }
        }
    },
    "metadata": {
        "property1": "string",
        "property2": "string"
    },
    "ref": "refs/heads/main",
    "scanned": "2020-06-13T19:52:50.000Z",
    "sha": "ddc951f4b1293222421f2c8df679786153acf689",
    "version": 0
}'

Response Example

{
    "created_at": "string",
    "id": 0,
    "message": "string",
    "result": "string"
}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Response

application/json

Body

Modified at 2023-08-15 02:59:24

Get a diff of the dependencies between commits