CG Scanning API V2
latest
    logoPowered by Apidog

    Top Vulnerabilities (widget)

    GET/v2/vulnerabilities/top_vulnerabilities
    Last modified: 3 days ago

    This endpoint returns the top vulnerabilities statistics.

    Request

    Query Params
    total
    enum<integer> 
    optional

    The number of vulnerabilities to return. Default: 10. Max: 50

    Allowed values:
    150
    severity
    enum<integer> 
    optional

    The minimum severity to return. Default: 4

    Allowed values:
    010
    page
    integer 
    optional

    Page number. Default: 1

    per_page
    integer 
    optional

    Number of records per page. Default: 10. Max: 100

    q
    string 
    optional

    Search by [:name, :severity, :nvt, :host, :port, :description, :family, :scan_name, :task_id, :report_id, :cve, :organization_id]. Usage q[column]='word'

    date_range_start
    string 
    optional

    Start date for date range filter. Format: YYYY-MM-DD hh:mm:ss

    date_range_end
    string 
    optional

    End date for date range filter. Default: current time. Format: YYYY-MM-DD hh:mm:ss

    relative_date_range
    string 
    optional

    Relative date range filter.
    Available units: (s)econds, (m)inutes, (h)ours, (d)ays, (M)onths, (y)ears. (q)uarter
    Example: Get the results for the last 10 days - 10d.
    Get the results from the first quarter at 2020 - 1q2020

    sort_by
    string 
    optional

    Sort by [:severity, :date, :qod]. Usage: column_name_desc or column_name_asc

    Request samples

    Responses

    OK(200)
    Unauthorized(401)
    HTTP Code: 200
    Content Type : JSONapplication/json

    Top Vulnerabilities (widget)

    Data Schema
    object {0}
    Example
    {}
    Last modified: 3 days ago