Skip to content
/
Replace the phishing tool...

Replace the phishing tool detection configuration

Request

Replaces your organization's phishing tool detection configuration with the configuration you send. Any rule you don't include is deleted.

A rule with an id updates the existing rule with that id. A rule without an id is created. Rules are evaluated in the order you send them, and the first rule that matches wins.

To change part of the configuration, retrieve it first, apply your changes, and send the complete configuration back.

Security
x-api-key
Bodyapplication/jsonrequired

The complete set of rules to save.

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.

curl -i -X PUT \
  https://eu1.api.pushsecurity.com/v1/controls/phishingToolDetection/configuration \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "globals": {},
    "rules": []
  }'

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": [ … ]
        }
      }
    }
  ]
}