Replace the file upload blocking configuration

Request

Replaces your organization's file upload blocking 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.

rulesArray of objects(File Upload Blocking Rule)required

Complete list of File Upload Blocking rules.

globalsobject

Reserved for control-wide settings. Empty for this control.

Example:

{}

PUT

/v1/controls/fileUploadBlocking/configuration

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

Responses

Bodyapplication/json

rulesArray of objects(File Upload Blocking Rule)required

Complete list of File Upload Blocking rules.

globalsobject

Reserved for control-wide settings. Empty for this control.

Example:

{}

Response

{
  "globals": {},
  "rules": [
    {
      "id": "c478966c-f927-411c-b919-179832d3d50c",
      "name": "Block executable uploads for Finance",
      "enabled": true,
      "mode": "BLOCK",
      "title": "Upload blocked",
      "subtext": "Uploading this file type is not permitted.",
      "buttonText": "Proceed anyway",
      "criteria": {
        "employeeIds": {
          "matches": [ … ]
        },
        "employeeGroups": {
          "matches": [ … ]
        },
        "fileNamePatterns": {
          "matches": [ … ]
        },
        "fileExtensions": {
          "matches": [ … ]
        },
        "urlPatterns": {
          "matches": [ … ]
        },
        "profileScope": {
          "matches": [ … ]
        }
      }
    }
  ]
}