Skip to content
/
Retrieve the clipboard bl...

Retrieve the clipboard blocking configuration

Request

Returns your organization's current clipboard blocking configuration, including the control-wide globals and 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/clipboardBlocking/configuration
curl -i -X GET \
  https://api.pushsecurity.com/v1/controls/clipboardBlocking/configuration \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
globalsobject(Clipboard Blocking Globals)required

Control-wide settings that apply across every rule.

rulesArray of objects(Clipboard Blocking Rule)required

Complete list of Clipboard Blocking rules.

Response
{
  "globals": {
    "customContentPatterns": [
      {
        "enum": "CUSTOM_INCIDENT_TICKET",
        "name": "Incident ticket",
        "regex": "INC-\\d{6}"
      }
    ]
  },
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Warn when copying incident tickets",
      "enabled": true,
      "mode": "WARN",
      "operation": "COPY",
      "contentCapture": true,
      "maskPii": true,
      "title": "Sensitive content",
      "subtext": "Copying incident tickets outside company applications is not permitted.",
      "copyRedactedButtonText": "Copy redacted",
      "copyOriginalButtonText": "Copy anyway",
      "acknowledgeButtonText": "Understood",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "urlPatterns": {
          "matches": [ … ]
        },
        "regexPatterns": {
          "matches": [ … ]
        },
        "profileScope": {
          "matches": [ … ]
        }
      }
    }
  ]
}