Skip to main content
GET
Declared licenses for one component (papi License service)

Query Parameters

purl
string
required

Package URL (e.g. pkg:github/scanoss/engine)

requirement
string

Optional version requirement (e.g. v5.4.5)

max_results_per_purl
integer

Caps the per-purl result array. 0/absent = no limit.

Required range: x >= 0

Enable the source-purl fallback lookup.

show_url
boolean
default:false

Include a url in results (placeholder — data source TBD).

on_version_not_found
enum<string>
default:strict

Version fallback strategy (not applied to range endpoints).

Available options:
strict,
show_latest,
show_closest_lt,
show_closest_gt,
show_any
encoded
enum<string>
default:none

Output encoding for content string values (none default, url_encoded, base64_encoded); control fields and object keys are never encoded.

Available options:
none,
url_encoded,
base64_encoded

Response

Licenses resolved for the component.

component
object

Per-component license result. info_code is one of REQUIREMENT_NOT_MET, VERSION_NOT_FOUND, NO_INFO (absent on an exact match).

status
object

Outcome of a licenses-service call (papi common StatusResponse).