Monitor (v1)

This document uses the v1 API. For more details, see the v1 API.

Monitor Dep Graph

Experimental! Note these endpoints are subject to change and only available to selected users. Please contact [e-mail] to request access.

The following package managers are supported:

• deb

• gomodules

• gradle

• maven

• nuget

• paket

• pip

• rpm

• rubygems

• cocoapods

• npm

• yarn

The name of the root node in the dep-graph is used as the project name when creating a project. This should be unique for your organization. In the example given below 'my-maven-app' will be the project name.

To inform Snyk that some dependencies in your project have changed ensure subsequent requests use the same root node name.Use this endpoint to monitor a DepGraph data object.

Required permissions

• View Organization

• Add Project

• Test Project

POSThttps://api.snyk.io/v1/monitor/dep-graph

Query parameters

Body

application/json; charset=utf-8

depGraph*MonitorDepGraphData

metaMonitorMetaData

any

Response

200

Body

application/json; charset=utf-8

ok*boolean

id*string

uri*string

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/monitor/dep-graph', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
    body: JSON.stringify({
      "depGraph": {
        "schemaVersion": "1.2.0",
        "pkgManager": {
          "name": "maven"
        },
        "pkgs": [
          {
            "id": "my-maven-app@1.0.0",
            "info": {
              "name": "my-maven-app",
              "version": "1.0.0"
            }
          },
          {
            "id": "ch.qos.logback:logback-core@1.0.13",
            "info": {
              "name": "ch.qos.logback:logback-core",
              "version": "1.0.13"
            }
          }
        ],
        "graph": {
          "rootNodeId": "root-node",
          "nodes": [
            {
              "nodeId": "root-node",
              "pkgId": "my-maven-app@1.0.0",
              "deps": [
                {
                  "nodeId": "ch.qos.logback:logback-core@1.0.13"
                }
              ]
            },
            {
              "nodeId": "ch.qos.logback:logback-core@1.0.13",
              "pkgId": "ch.qos.logback:logback-core@1.0.13",
              "deps": []
            }
          ]
        }
      }
    }),
});
const data = await response.json();

Response

200

{
  "ok": true,
  "id": "f7c065cd-5850-462d-a0ca-9719d07e3e38",
  "uri": "https://app.snyk.io/org/my-org/project/f7c065cd-5850-462d-a0ca-9719d07e3e38/history/39d14036-31f3-4f22-8037-1d979e0516ef"
}