Get License Summary
curl --request GET \
--url https://api.example.com/project/{projectId}/results/sca/licenses/summary{
"success": true,
"data": {
"projectId": "550e8400-e29b-41d4-a716-446655440001",
"totalPackages": 142,
"packagesWithLicenses": 135,
"packagesWithoutLicenses": 7,
"permissiveCount": 120,
"weakCopyleftCount": 8,
"strongCopyleftCount": 3,
"unknownCount": 7,
"ignoredCount": 4,
"licenses": [
{
"spdxId": "MIT",
"name": "MIT License",
"category": "PERMISSIVE",
"risk": "NONE",
"riskDescription": "Minimal restrictions on use, modification, and redistribution",
"count": 85
},
{
"spdxId": "Apache-2.0",
"name": "Apache License 2.0",
"category": "PERMISSIVE",
"risk": "NONE",
"riskDescription": "Minimal restrictions on use, modification, and redistribution",
"count": 25
},
{
"spdxId": "GPL-3.0-only",
"name": "GNU General Public License v3.0 only",
"category": "STRONG_COPYLEFT",
"risk": "HIGH",
"riskDescription": "Requires derivative works to be released under the same license",
"count": 3
}
]
}
}
Project Licenses
Get License Summary
Get aggregated license statistics for all SCA packages in a project
GET
/
project
/
{projectId}
/
results
/
sca
/
licenses
/
summary
Get License Summary
curl --request GET \
--url https://api.example.com/project/{projectId}/results/sca/licenses/summary{
"success": true,
"data": {
"projectId": "550e8400-e29b-41d4-a716-446655440001",
"totalPackages": 142,
"packagesWithLicenses": 135,
"packagesWithoutLicenses": 7,
"permissiveCount": 120,
"weakCopyleftCount": 8,
"strongCopyleftCount": 3,
"unknownCount": 7,
"ignoredCount": 4,
"licenses": [
{
"spdxId": "MIT",
"name": "MIT License",
"category": "PERMISSIVE",
"risk": "NONE",
"riskDescription": "Minimal restrictions on use, modification, and redistribution",
"count": 85
},
{
"spdxId": "Apache-2.0",
"name": "Apache License 2.0",
"category": "PERMISSIVE",
"risk": "NONE",
"riskDescription": "Minimal restrictions on use, modification, and redistribution",
"count": 25
},
{
"spdxId": "GPL-3.0-only",
"name": "GNU General Public License v3.0 only",
"category": "STRONG_COPYLEFT",
"risk": "HIGH",
"riskDescription": "Requires derivative works to be released under the same license",
"count": 3
}
]
}
}
Path Parameters
The UUID of the project
Query Parameters
Filter by Git branch name
The UUID of the organization (required for permission resolution)
Filter by package ecosystem (e.g.,
npm, pip, maven, go). Can be specified multiple times.Authorization
Requiresread_scan_result permission on the project.
Response
Whether the request succeeded
Show License Summary Object
Show License Summary Object
The project UUID
Total number of SCA packages
Number of packages with at least one detected license
Number of packages with no detected license
Number of packages classified as Permissive
Number of packages classified as Weak Copyleft
Number of packages classified as Strong Copyleft
Number of packages with unknown or unresolved licenses
Number of packages marked as ignored for license analysis
Show License Item
Show License Item
SPDX license identifier (e.g.,
MIT, Apache-2.0)Human-readable license name
License category:
PERMISSIVE, WEAK_COPYLEFT, STRONG_COPYLEFT, or UNKNOWNRisk level:
NONE, MEDIUM, HIGH, or UNKNOWNHuman-readable description of the risk implications
Number of packages using this license
{
"success": true,
"data": {
"projectId": "550e8400-e29b-41d4-a716-446655440001",
"totalPackages": 142,
"packagesWithLicenses": 135,
"packagesWithoutLicenses": 7,
"permissiveCount": 120,
"weakCopyleftCount": 8,
"strongCopyleftCount": 3,
"unknownCount": 7,
"ignoredCount": 4,
"licenses": [
{
"spdxId": "MIT",
"name": "MIT License",
"category": "PERMISSIVE",
"risk": "NONE",
"riskDescription": "Minimal restrictions on use, modification, and redistribution",
"count": 85
},
{
"spdxId": "Apache-2.0",
"name": "Apache License 2.0",
"category": "PERMISSIVE",
"risk": "NONE",
"riskDescription": "Minimal restrictions on use, modification, and redistribution",
"count": 25
},
{
"spdxId": "GPL-3.0-only",
"name": "GNU General Public License v3.0 only",
"category": "STRONG_COPYLEFT",
"risk": "HIGH",
"riskDescription": "Requires derivative works to be released under the same license",
"count": 3
}
]
}
}
⌘I