Licenses (v1)
Note: When you import or update Projects, changes will be reflected in the endpoint results after a one-hour delay.
Required permissions
View Organization
View Project
View Project Snapshot
Path parameters
orgIdstringRequiredExample:
The organization ID to list projects for. The API_KEY
must have access to this organization.
4a18d42f-0706-4ad0-b127-24078731fbed
Query parameters
sortByall ofOptional
The field to sort results by.
string · enumOptionalPossible values:
anyOptionalExample:
The field to sort results by.
license
orderall ofOptional
The direction to sort results by.
string · enumOptionalPossible values:
anyOptional
The direction to sort results by.
Body
Responses
200Success
application/json
Responseall of
and
anyOptionalExample:
{"results":[{"id":"MIT","severity":"none","instructions":"","dependencies":[{"id":"[email protected]","name":"accepts","version":"1.0.0","packageManager":"npm"}],"projects":[{"name":"atokeneduser/goof","id":"6d5813be-7e6d-4ab8-80c2-1e3e2a454545"}]}],"total":1}
post
POST /v1/org/{orgId}/licenses HTTP/1.1
Host: api.snyk.io
Content-Type: application/json
Accept: */*
Content-Length: 142
{
"filters": {
"languages": [
"node",
"ruby",
"java",
"cpp"
],
"projects": [],
"dependencies": [],
"licenses": [],
"severity": [
"none",
"high",
"medium",
"low"
]
}
}
200Success
{
"results": [
{
"id": "MIT",
"severity": "none",
"instructions": "",
"dependencies": [
{
"id": "[email protected]",
"name": "accepts",
"version": "1.0.0",
"packageManager": "npm"
}
],
"projects": [
{
"name": "atokeneduser/goof",
"id": "6d5813be-7e6d-4ab8-80c2-1e3e2a454545"
}
]
}
],
"total": 1
}
Last updated
Was this helpful?