Docs

Get Revision Component Matches

gethttps://app.fossa.com/api/binary/{revisionLocator}/{componentId}/matches

Get Matches for a Binary Decomposition Component for a Revision

Path parameters

revisionLocatorstringrequired

Binary Decomposition project revision

componentIdstringrequired

The ID of the component

Query parameters

pageinteger

The specific page of data to return

pageSizeinteger

The number of items to return in each page of results

Responses

200A list of matches associated with a component of a Binary Decomposition project revision.
resultsobject[]
matchStringstring

The string the match occurred on

countnumber

The number occurences of match string

pagenumber

pagination page

pageSizenumber

pagination page page size

totalCountnumber

total count of component matches

400Bad Request
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

401Unauthorized
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

403Forbidden — the Binary Decomposition feature is not enabled for this organization. Every `/api/binary` endpoint is gated behind the `binaryDecomposition` feature flag, so a request from an organization without it returns this error.
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

404Not Found
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

500Server Error
uuidstring

Unique identifier associated with the error

codeinteger

fossa specific error code

messagestring

message associated with this error

namestring

name of the error

httpStatusCodeinteger

http status code number

Try this endpoint

Build a request and run it against app.fossa.com.

Bearer

Stored in this browser for 24 hours. Try It uses a docs proxy for CORS and does not store tokens server-side.

GET https://app.fossa.com/api/binary/%7BrevisionLocator%7D/%7BcomponentId%7D/matches
curl --request GET \  --url 'https://app.fossa.com/api/binary/%7BrevisionLocator%7D/%7BcomponentId%7D/matches' \  --header 'accept: application/json' \  --header 'authorization: Bearer YOUR_API_TOKEN'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Enter a Bearer token before running this request.

Path params

revisionLocatorstringrequired

Binary Decomposition project revision

componentIdstringrequired

The ID of the component

Query params

pageinteger

The specific page of data to return

pageSizeinteger

The number of items to return in each page of results

← All Binary endpoints