Licenses (v1)

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

Note: When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay.

List all licenses

Required permissions

• View Organization

• View Project

• View Project Snapshot

POSThttps://api.snyk.io/v1/org/{orgId}/licenses

Path parameters

orgId*string

The organization ID to list projects for. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Query parameters

Body

application/json

filtersfilters5

any

Response

200

Body

application/json; charset=utf-8

results*array of results1

A list of licenses

totalnumber

The number of results returned

any

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://api.snyk.io/v1/org/{orgId}/licenses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filters": {
        "languages": [
          "node",
          "ruby",
          "java",
          "cpp"
        ],
        "projects": [],
        "dependencies": [],
        "licenses": [],
        "severity": [
          "none",
          "high",
          "medium",
          "low"
        ]
      }
    }),
});
const data = await response.json();

Response

200

{
  "results": [
    {
      "id": "MIT",
      "severity": "none",
      "instructions": "",
      "dependencies": [
        {
          "id": "accepts@1.0.0",
          "name": "accepts",
          "version": "1.0.0",
          "packageManager": "npm"
        }
      ],
      "projects": [
        {
          "name": "atokeneduser/goof",
          "id": "6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
        }
      ]
    }
  ],
  "total": 1
}