Query

JSON

JSON

{
   "filters": [
        {
            "property": String, // Any property of the entity
            "operator": String, // Operator to be filtered by
            "values":[String] // Values to compare
        }
    ],
    "sort": [
        {
            "property": String, // Any property of the entity
            "direction": String // ascending, descending
        }
    ],
    "paging": {
        "limit": Integer, // Entities per page. The default value is 100
        "offset": Integer // Page number
    }
}

The operator can be: equal, greater, smaller, includes, or distinct.

equal: The property value must equal one of the values to be compared.

greater: The property value must be greater than all values to be compared.

smaller: The property value must be smaller than all values to be compared.

distinct: The property value must be distinct from all values to be compared.

includes: The property value must be like all the values to be compared.

Pentest Example

JSON

{
   "filters": [
        {
            "property": "status",
            "operator": "equal",
            "values":["ONGOING"]
        },
        {
            "property": "color",
            "operator": "distinct",
            "values":["GREY"]
        }
    ],
    "sort": [
        {
            "property": "startedAt",
            "direction": "ascending"
        }
    ],
    "paging": {
        "limit": 10,
        "offset": 0
    }
}

This query will fetch all pentests in ONGOING status and whose color is not GREY. They will be ordered by startedDate ascending and paginated every 10 pentests.

Check Base Pentest Data/Response section to see all the pentest properties

Vulnerability Example

JSON

{
   "filters": [
        {
            "property": "severity",
            "operator": "equal",
            "values":["HIGH", "MEDIUM"]
        },
        {
            "property": "status",
            "operator": "equal",
            "values":["PENDING_FIX"]
        }
    ],
    "sort": [
        {
            "property": "createdAt",
            "direction": "ascending"
        }
    ],
    "paging": {
        "limit": 10,
        "offset": 0
    }
}

This query will fetch all vulnerabilities whose severity is CRITICAL or HIGH and whose status is PENDING_FIX. They will be ordered by createdAt ascending and paginated every 10 vulnerabilities.

Check Base Vulnerability Data/Response section to see all the pentest properties