Skip to content
/
List detections

List detections

Request

Retrieve a list of detection objects

Security
x-api-key
Query
archivedboolean

Filter by whether the detection has been archived.

severityany(SeverityType)

Filter by the severity.

Enum:"LOW""MEDIUM""HIGH""CRITICAL"
detectionTypeany(DetectionType)

Filter by the detection type.

Enum:"BLOCKED_URL""CUSTOM""PHISHING""MALICIOUS_BROWSER_EXTENSION""MALWARE_DELIVERY""STOLEN_CREDENTIALS"
Example:detectionType=PHISHING
responseany(ResponseType)

Filter by the response.

Enum:"BLOCKED""EMPLOYEE_IGNORED_WARNING""EMPLOYEE_WARNED""NOT_BLOCKED"
classificationstring(ClassificationType)

Filter by the classification.

Enum:"NOT_SET""TRUE_POSITIVE""BENIGN_TRUE_POSITIVE""FALSE_POSITIVE"
creationTimestampAfterinteger

Filter by when the detection was created - start time. This is a UNIX timestamp (in seconds).

creationTimestampBeforeinteger

Filter by when the detection was created - end time. This is a UNIX timestamp (in seconds).

limitinteger, [ 1 .. 500 ]

Used for pagination. Number of objects to return.

Default:500
nextTokenstring

Used for pagination. Token to be used for the next request.

GET
/v1/detections
curl -i -X GET \
  https://api.pushsecurity.com/v1/detections \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
resultArray of objects(Detection)
pagingobject
Response
{
  "result": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "employeeId": "37cda962-7e78-49bc-8721-1becd16276a3",
      "employee": {
        "id": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
        "email": "john.hill@example.com",
        "firstName": "John",
        "lastName": "Hill",
        "department": "Security Engineering",
        "location": "New York",
        "licensed": true,
        "chatopsEnabled": true,
        "creationTimestamp": 1698669223
      },
      "browserId": "2a2197de-ad2c-47e4-8dcb-fb0f04cf83e0",
      "severity": "HIGH",
      "detectionType": "PHISHING",
      "response": "BLOCKED",
      "creationTimestamp": 1698604061,
      "archived": true
    }
  ],
  "paging": {
    "moreResults": true,
    "nextToken": "0b9972aa-fe8d-4095-82d3-2e13cf3cfd43"
  }
}