Docs

Get the details of a specific snippet match

gethttps://app.fossa.com/api/revisions/{locator}/snippets/{snippetId}/matches/{path}

Retrieve detailed match information for a snippet at a specific path, including reference and detected code lines.

Path parameters

locatorstringrequired

The revision locator

snippetIdstringrequired

The unique identifier of the snippet

pathstringrequired

The file path where the snippet match occurred

Responses

200Successfully retrieved snippet match details
matchDetailsobjectrequired
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
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

404Snippet match details not 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

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/revisions/%7Blocator%7D/snippets/%7BsnippetId%7D/matches/%7Bpath%7D
curl --request GET \  --url 'https://app.fossa.com/api/revisions/%7Blocator%7D/snippets/%7BsnippetId%7D/matches/%7Bpath%7D' \  --header 'accept: application/json'

Real request. Mutating methods can change data.

Click Try It to run a request and see the response here.
Missing path params: locator, snippetId, path

Path params

locatorstringrequired

The revision locator

snippetIdstringrequired

The unique identifier of the snippet

pathstringrequired

The file path where the snippet match occurred

← All Snippets endpoints