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

post

/org/{orgId}/licenses

Path parameters

orgIdstringrequired

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

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

Query parameters

sortByall of

The field to sort results by.

orderall of

The direction to sort results by.

Body

filtersfilters5

any

Example: {"filters":{"languages":["node","ruby","java","cpp"],"projects":[],"dependencies":[],"licenses":[],"severity":["none","high","medium","low"]}}

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.snyk.io/v1/org/{orgId}/licenses' \
  --header 'Content-Type: application/json' \
  --data '{"filters":{"languages":["node","ruby","java","cpp"],"projects":[],"dependencies":[],"licenses":[],"severity":["none","high","medium","low"]}}'

200

200

{
  "total": 1,
  "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"
        }
      ]
    }
  ]
}