Skip to content

Get repository analysis report

Retrieves the report of a completed analysis.

GET /v1/analyzer/git/:track_id/

Parameters

Name Type Description Required
track_id string The unique identifier for the completed analysis. Yes

Request

curl -X GET 'https://api.y2ksecurity.com/v1/analyzer/git/1234-abcd/' \
-H 'Authorization: Token Y2KSEC_API_KEY'

Responses

200 OK

Example Content:

{
    "user": "username",
    "repo": "https://github.com/username/repository",
    "subdir": "src",
    "track_id": "1234-abcd",
    "created_at": "2023-07-31T00:00:00Z",
    "all_files": ["file1.py", "file2.py", "file3.py", "file4.py"],
    "vulnerabilities": [
        {
            "file_name": "file1.py",
            "vulnerabilities": ["Vulnerability1", "Vulnerability2"]
        },
        {
            "file_name": "file2.py",
            "vulnerabilities": ["Vulnerability3", "Vulnerability4"]
        }
    ],
    "analyzed_files": [
        {
            "file_path": "file1.py",
            "result_base64": "SGVsbG8gd29ybGQ=",
            "task_id": "abcd1234",
            "vulnerability": true,
            "created_at": "2023-07-31T00:00:00Z"
        },
        {
            "file_path": "file2.py",
            "result_base64": "SGVsbG8gd29ybGQ=",
            "task_id": "abcd1234",
            "vulnerability": false,
            "created_at": "2023-07-31T00:00:00Z"
        }
    ]
}
404 NOT FOUND

Condition: If 'track_id' does not match any completed analysis.

Example Content:

{
    "message": "No matching scan found for the given track id."
}