Skip to content
/
Replace the clipboard blo...

Replace the clipboard blocking configuration

Request

Replaces your organization's clipboard blocking configuration with the configuration you send. Any rule you don't include is deleted, and globals.customContentPatterns replaces your entire custom-pattern list — send the complete set you want to keep, or an empty array to clear it.

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 configuration to save.

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.

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

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