Skip to content

Phishing tool detection

Manage the rules that detect phishing tools across your organization.

Operations

Retrieve the phishing tool detection configuration

Request

Returns your organization's current phishing tool detection configuration, including every rule and its settings. Rules are returned in the order they're evaluated, with the highest-priority rule first.

Security
x-api-key
GET
/v1/controls/phishingToolDetection/configuration
curl -i -X GET \
  https://api.pushsecurity.com/v1/controls/phishingToolDetection/configuration \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
globalsobject(Phishing Tool Detection Globals)required

Control-wide settings that apply across every rule.

rulesArray of objects(Phishing Tool Detection Rule)required

Complete list of Phishing Tool Detection rules.

Response
{
  "globals": {
    "ignoredHosts": [
      "*.internal.example.com",
      "build-server",
      "10.0.1.1"
    ]
  },
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Warn Finance about phishing tools",
      "enabled": true,
      "mode": "WARN",
      "title": "Potential phishing tool detected",
      "subtext": "This page looks like a phishing tool. Proceed only if you trust it.",
      "ignoreButtonText": "Proceed anyway",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        }
      }
    }
  ]
}