Zscaler

App · 25 actions

Manage Zscaler Internet Access: URL categories, the allow and deny lists, URL filtering rules and activation, look up users and URLs, and start workflows when users, rules or pending changes appear.

Actions

ActionWhat it does
Activate changesActivate every saved change in Zscaler Internet Access, so it reaches traffic.
Add URLs to allowlistAdd URLs to the allowlist, so threat scanning skips them.
Add URLs to denylistBlock URLs by adding them to the denylist.
Add URLs to URL categoryAdd URLs to a URL category, keeping the ones it has.
Create URL categoryCreate a custom URL category holding the URLs given, for URL filtering and other policies to use.
Delete URL categoryDelete one of your organization's custom URL categories.
Get activation statusFind out whether saved changes are waiting to be activated.
Get allowlistGet the allowlist: URLs the malware, advanced threat and sandbox policies don't scan.
Get denylistGet the denylist: URLs your organization blocks outright.
Get sandbox reportGet the Cloud Sandbox's verdict on a file by its MD5 hash: malicious, suspicious or benign, its threat score and the file's details.
Get URL categoryGet one URL category with its custom URLs, keywords and IP ranges.
Get URL filtering ruleGet one URL filtering rule with its conditions and action.
Get userGet one user with their email, department and groups.
List departmentsList departments, optionally matching a search.
List firewall rulesList the cloud firewall rules with their order, action, state and what each matches.
List groupsList user groups, optionally matching a search.
List locationsList locations (offices and sites) with their IP addresses and settings, optionally matching a search.
List URL categoriesList the URL categories: Zscaler's own and your organization's custom ones, with their custom URLs and keywords.
List URL filtering rulesList the URL filtering rules with their order, action, state and the categories, users and locations each covers.
List usersList users with their email, department and groups, by name, department or group.
Look up URL categoriesFind which URL categories Zscaler files each URL under, including security categories such as malware or phishing.
Remove URLs from allowlistTake URLs off the allowlist, so threat scanning covers them again.
Remove URLs from denylistUnblock URLs by taking them off the denylist.
Remove URLs from URL categoryTake URLs out of a URL category, keeping the rest.
Turn URL filtering rule on or offEnable or disable a URL filtering rule, leaving the rest of it as it is.

Activate changes

Activate every saved change in Zscaler Internet Access, so it reaches traffic. This includes changes other admins have saved.

Inputs

None.

Outputs

pendingtrue/false
True while changes wait
statustext
ACTIVE, PENDING (changes wait) or INPROGRESS
Example output
{
  "pending": false,
  "status": "ACTIVE"
}

Add URLs to allowlist

Add URLs to the allowlist, so threat scanning skips them. It holds up to 255. Takes effect once changes are activated.

Inputs

URLsurlslistRequired
The URLs or domains to add, one per row.

Outputs

addedlist
The URLs added
countnumber
How many URLs the allowlist holds
notetext
Whether the change waits for activation, or that nothing changed
unchangedlist
The URLs given that were already as asked
urlslist
Every URL on the allowlist now
Example output
{
  "added": [
    "example.net"
  ],
  "count": 2,
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "unchanged": [],
  "urls": [
    "example.com",
    "example.net"
  ]
}

Add URLs to denylist

Block URLs by adding them to the denylist. Takes effect once changes are activated.

Inputs

URLsurlslistRequired
The URLs or domains to block, one per row.

Outputs

addedlist
The URLs added
countnumber
How many URLs the denylist holds
notetext
Whether the change waits for activation, or that nothing changed
unchangedlist
The URLs given that were already as asked
urlslist
Every URL on the denylist now
Example output
{
  "added": [
    "example.net"
  ],
  "count": 2,
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "unchanged": [],
  "urls": [
    "example.com",
    "example.net"
  ]
}

Add URLs to URL category

Add URLs to a URL category, keeping the ones it has. Takes effect once changes are activated.

Inputs

URL categorycategory_idtextRequired
The category. Pick one, or give its id.
URLsurlslistRequired
The URLs and domains to add, one per row, such as example.com, or .example.com for it and every subdomain.

Outputs

addedlist
The URLs added
categoryobject
The URL category as it is now
notetext
Whether the change waits for activation, or that nothing changed
unchangedlist
The URLs given that were already as asked
Example output
{
  "added": [
    "vendor.example.org"
  ],
  "category": {
    "configuredName": "Approved vendors",
    "customCategory": true,
    "customUrlsCount": 2,
    "dbCategorizedUrls": [],
    "description": "Sites staff may always reach",
    "editable": true,
    "id": "CUSTOM_01",
    "ipRanges": [],
    "keywords": [],
    "superCategory": "USER_DEFINED",
    "type": "URL_CATEGORY",
    "urls": [
      ".example.com",
      "vendor.example.org"
    ],
    "val": 128
  },
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "unchanged": []
}

Create URL category

Create a custom URL category holding the URLs given, for URL filtering and other policies to use. It takes effect once changes are activated.

Inputs

NamenametextRequired
The category's name, as admins will see it.
URLsurlslistRequired
The URLs and domains in the category, one per row, such as example.com, or .example.com for it and every subdomain.
Descriptiondescriptiontext
What the category is for.

Outputs

categoryobject
The new URL category
notetext
Whether the change waits for activation, or that nothing changed
Example output
{
  "category": {
    "configuredName": "Approved vendors",
    "customCategory": true,
    "customUrlsCount": 2,
    "dbCategorizedUrls": [],
    "description": "Sites staff may always reach",
    "editable": true,
    "id": "CUSTOM_01",
    "ipRanges": [],
    "keywords": [],
    "superCategory": "USER_DEFINED",
    "type": "URL_CATEGORY",
    "urls": [
      ".example.com",
      "vendor.example.org"
    ],
    "val": 128
  },
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console."
}

Delete URL category

Delete one of your organization's custom URL categories. A category a rule still uses can't be deleted. Takes effect once changes are activated.

Inputs

URL categorycategory_idtextRequired
The custom category to delete. Pick one, or give its id, such as CUSTOM_01.

Outputs

category_idtext
The deleted category's id
deletedtrue/false
True once deleted
notetext
Whether the change waits for activation, or that nothing changed
Example output
{
  "category_id": "CUSTOM_01",
  "deleted": true,
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console."
}

Get activation status

Find out whether saved changes are waiting to be activated.

Inputs

None.

Outputs

pendingtrue/false
True while changes wait
statustext
ACTIVE, PENDING (changes wait) or INPROGRESS
Example output
{
  "pending": true,
  "status": "PENDING"
}

Get allowlist

Get the allowlist: URLs the malware, advanced threat and sandbox policies don't scan.

Inputs

None.

Outputs

countnumber
How many URLs it holds
urlslist
The URLs on the allowlist
Example output
{
  "count": 1,
  "urls": [
    "example.com"
  ]
}

Get denylist

Get the denylist: URLs your organization blocks outright.

Inputs

None.

Outputs

countnumber
How many URLs it holds
urlslist
The URLs on the denylist
Example output
{
  "count": 1,
  "urls": [
    "blocked.example.com"
  ]
}

Get sandbox report

Get the Cloud Sandbox's verdict on a file by its MD5 hash: malicious, suspicious or benign, its threat score and the file's details.

Inputs

MD5 hashmd5textRequired
The file's MD5 hash: 32 letters and digits.
Detaildetailstext
A summary, or the full report. Defaults to the summary.One of: summary (Summary (default)), full.

Outputs

foundtrue/false
False when there is no report
md5text
The hash looked up
messagetext
Why there is no report, when there isn't one
reportobject
The report: its summary, verdict and file details
Example output
{
  "found": true,
  "md5": "3e1b3e2c7e2a5d4c9f0a1b2c3d4e5f60",
  "message": "",
  "report": {
    "Classification": {
      "Category": "MALWARE_BOTNET",
      "DetectedMalware": "Trojan.Generic",
      "Score": 100,
      "Type": "MALICIOUS"
    },
    "FileProperties": {
      "DigitalCerificate": "",
      "FileSize": 405504,
      "FileType": "exe",
      "Issuer": "",
      "MD5": "3e1b3e2c7e2a5d4c9f0a1b2c3d4e5f60",
      "RootCA": "",
      "SHA1": "a94a8fe5ccb19ba61c4c0873d391e987982fbbd3",
      "SSDeep": "6144:abc",
      "Sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"
    },
    "Summary": {
      "Category": "EXECUTABLE",
      "Duration": 312000,
      "FileType": "exe",
      "StartTime": 1762905600,
      "Status": "COMPLETED"
    }
  }
}

Get URL category

Get one URL category with its custom URLs, keywords and IP ranges.

Inputs

URL categorycategory_idtextRequired
The category. Pick one, or give its id.

Outputs

categoryobject
The URL category
Example output
{
  "category": {
    "configuredName": "Approved vendors",
    "customCategory": true,
    "customUrlsCount": 2,
    "dbCategorizedUrls": [],
    "description": "Sites staff may always reach",
    "editable": true,
    "id": "CUSTOM_01",
    "ipRanges": [],
    "keywords": [],
    "superCategory": "USER_DEFINED",
    "type": "URL_CATEGORY",
    "urls": [
      ".example.com",
      "vendor.example.org"
    ],
    "val": 128
  }
}

Get URL filtering rule

Get one URL filtering rule with its conditions and action.

Inputs

URL filtering rulerule_idtextRequired
The rule. Pick one, or give its id.

Outputs

ruleobject
The rule
Example output
{
  "rule": {
    "action": "BLOCK",
    "departments": [
      {
        "id": 81896,
        "name": "Sales"
      }
    ],
    "description": "No gambling sites at work",
    "groups": [],
    "id": 1203,
    "lastModifiedBy": {
      "id": 4512,
      "name": "admin@example.com"
    },
    "lastModifiedTime": 1762905600,
    "locations": [],
    "name": "Block gambling",
    "order": 1,
    "protocols": [
      "HTTPS_RULE",
      "HTTP_RULE"
    ],
    "rank": 7,
    "requestMethods": [
      "GET",
      "POST"
    ],
    "state": "ENABLED",
    "urlCategories": [
      "GAMBLING"
    ],
    "users": []
  }
}

Get user

Get one user with their email, department and groups.

Inputs

UserusertextRequired
The user. Pick one, or give their id from 'List users'.

Outputs

userobject
The user
Example output
{
  "user": {
    "adminUser": false,
    "comments": "",
    "deleted": false,
    "department": {
      "id": 81896,
      "name": "Sales"
    },
    "email": "jo@example.com",
    "groups": [
      {
        "id": 81900,
        "name": "Finance"
      }
    ],
    "id": 70021,
    "name": "Jo Bloggs",
    "type": ""
  }
}

List departments

List departments, optionally matching a search. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchsearchtext
Only those whose name matches this text.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many came back
departmentslist
The departments
next_pagenumber
The next page to read, or 0 when this was the last
pagenumber
The page read
Example output
{
  "count": 1,
  "departments": [
    {
      "comments": "",
      "deleted": false,
      "id": 81896,
      "idpId": 0,
      "name": "Sales"
    }
  ],
  "next_page": 0,
  "page": 1
}

List firewall rules

List the cloud firewall rules with their order, action, state and what each matches.

Inputs

None.

Outputs

countnumber
How many came back
ruleslist
The firewall rules
Example output
{
  "count": 1,
  "rules": [
    {
      "action": "BLOCK_DROP",
      "defaultRule": false,
      "departments": [],
      "description": "",
      "destAddresses": [],
      "destCountries": [],
      "groups": [],
      "id": 2201,
      "lastModifiedBy": {
        "id": 4512,
        "name": "admin@example.com"
      },
      "lastModifiedTime": 1762905600,
      "locations": [],
      "name": "Block outbound SMB",
      "nwServices": [
        {
          "id": 774,
          "name": "SMB"
        }
      ],
      "order": 1,
      "predefined": false,
      "rank": 7,
      "srcIps": [],
      "state": "ENABLED",
      "users": []
    }
  ]
}

List groups

List user groups, optionally matching a search. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchsearchtext
Only those whose name matches this text.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many came back
groupslist
The groups
next_pagenumber
The next page to read, or 0 when this was the last
pagenumber
The page read
Example output
{
  "count": 1,
  "groups": [
    {
      "comments": "",
      "id": 81900,
      "idpId": 0,
      "name": "Finance"
    }
  ],
  "next_page": 0,
  "page": 1
}

List locations

List locations (offices and sites) with their IP addresses and settings, optionally matching a search. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchsearchtext
Only those whose name matches this text.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 1,000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many came back
locationslist
The locations
next_pagenumber
The next page to read, or 0 when this was the last
pagenumber
The page read
Example output
{
  "count": 1,
  "locations": [
    {
      "authRequired": true,
      "country": "UNITED_STATES",
      "description": "",
      "id": 30441,
      "ipAddresses": [
        "203.0.113.10"
      ],
      "ipsControl": true,
      "name": "Head office",
      "ofwEnabled": true,
      "parentId": 0,
      "ports": [],
      "profile": "CORPORATE",
      "sslScanEnabled": true,
      "tz": "UNITED_STATES_AMERICA_NEW_YORK",
      "xffForwardEnabled": false
    }
  ],
  "next_page": 0,
  "page": 1
}

List URL categories

List the URL categories: Zscaler's own and your organization's custom ones, with their custom URLs and keywords.

Inputs

Only custom categoriescustom_onlytrue/false
Turn on to list only the categories your organization made.

Outputs

categorieslist
The URL categories
countnumber
How many came back
Example output
{
  "categories": [
    {
      "configuredName": "Approved vendors",
      "customCategory": true,
      "customUrlsCount": 2,
      "dbCategorizedUrls": [],
      "description": "Sites staff may always reach",
      "editable": true,
      "id": "CUSTOM_01",
      "ipRanges": [],
      "keywords": [],
      "superCategory": "USER_DEFINED",
      "type": "URL_CATEGORY",
      "urls": [
        ".example.com",
        "vendor.example.org"
      ],
      "val": 128
    }
  ],
  "count": 1
}

List URL filtering rules

List the URL filtering rules with their order, action, state and the categories, users and locations each covers.

Inputs

None.

Outputs

countnumber
How many came back
ruleslist
The URL filtering rules
Example output
{
  "count": 1,
  "rules": [
    {
      "action": "BLOCK",
      "departments": [
        {
          "id": 81896,
          "name": "Sales"
        }
      ],
      "description": "No gambling sites at work",
      "groups": [],
      "id": 1203,
      "lastModifiedBy": {
        "id": 4512,
        "name": "admin@example.com"
      },
      "lastModifiedTime": 1762905600,
      "locations": [],
      "name": "Block gambling",
      "order": 1,
      "protocols": [
        "HTTPS_RULE",
        "HTTP_RULE"
      ],
      "rank": 7,
      "requestMethods": [
        "GET",
        "POST"
      ],
      "state": "ENABLED",
      "urlCategories": [
        "GAMBLING"
      ],
      "users": []
    }
  ]
}

List users

List users with their email, department and groups, by name, department or group. Gets one page; to see more, run it again with the next page it gives.

Inputs

Namenametext
Only users whose name starts with this.
Departmentdepartmenttext
Only users in a department whose name starts with this.
Groupgrouptext
Only users in a group whose name starts with this.
Pagepagenumber
Which page to get, from 1. Use the 'next_page' an earlier run gave to read on.At least 1.
Page sizepage_sizenumber
How many to return, 1 to 10,000. Defaults to 100.From 1 to 10000.

Outputs

countnumber
How many came back
next_pagenumber
The next page to read, or 0 when this was the last
pagenumber
The page read
userslist
The users
Example output
{
  "count": 1,
  "next_page": 0,
  "page": 1,
  "users": [
    {
      "adminUser": false,
      "comments": "",
      "deleted": false,
      "department": {
        "id": 81896,
        "name": "Sales"
      },
      "email": "jo@example.com",
      "groups": [
        {
          "id": 81900,
          "name": "Finance"
        }
      ],
      "id": 70021,
      "name": "Jo Bloggs",
      "type": ""
    }
  ]
}

Look up URL categories

Find which URL categories Zscaler files each URL under, including security categories such as malware or phishing.

Inputs

URLsurlslistRequired
Up to 100 URLs or domains, one per row.

Outputs

countnumber
How many came back
resultslist
Each URL and its categories
Example output
{
  "count": 1,
  "results": [
    {
      "application": "",
      "url": "example.com",
      "urlClassifications": [
        "WEB_SEARCH"
      ],
      "urlClassificationsWithSecurityAlert": []
    }
  ]
}

Remove URLs from allowlist

Take URLs off the allowlist, so threat scanning covers them again. Takes effect once changes are activated.

Inputs

URLsurlslistRequired
The URLs to take off, one per row, exactly as listed.

Outputs

countnumber
How many URLs the allowlist holds
notetext
Whether the change waits for activation, or that nothing changed
removedlist
The URLs removed
unchangedlist
The URLs given that were already as asked
urlslist
Every URL on the allowlist now
Example output
{
  "count": 2,
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "removed": [
    "example.net"
  ],
  "unchanged": [],
  "urls": [
    "example.com",
    "example.net"
  ]
}

Remove URLs from denylist

Unblock URLs by taking them off the denylist. Takes effect once changes are activated.

Inputs

URLsurlslistRequired
The URLs to take off, one per row, exactly as listed.

Outputs

countnumber
How many URLs the denylist holds
notetext
Whether the change waits for activation, or that nothing changed
removedlist
The URLs removed
unchangedlist
The URLs given that were already as asked
urlslist
Every URL on the denylist now
Example output
{
  "count": 2,
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "removed": [
    "example.net"
  ],
  "unchanged": [],
  "urls": [
    "example.com",
    "example.net"
  ]
}

Remove URLs from URL category

Take URLs out of a URL category, keeping the rest. A category must keep at least one URL, keyword or IP range. Takes effect once changes are activated.

Inputs

URL categorycategory_idtextRequired
The category. Pick one, or give its id.
URLsurlslistRequired
The URLs to take out, one per row, exactly as listed.

Outputs

categoryobject
The URL category as it is now
notetext
Whether the change waits for activation, or that nothing changed
removedlist
The URLs removed
unchangedlist
The URLs given that were already as asked
Example output
{
  "category": {
    "configuredName": "Approved vendors",
    "customCategory": true,
    "customUrlsCount": 2,
    "dbCategorizedUrls": [],
    "description": "Sites staff may always reach",
    "editable": true,
    "id": "CUSTOM_01",
    "ipRanges": [],
    "keywords": [],
    "superCategory": "USER_DEFINED",
    "type": "URL_CATEGORY",
    "urls": [
      ".example.com",
      "vendor.example.org"
    ],
    "val": 128
  },
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "removed": [
    "vendor.example.org"
  ],
  "unchanged": []
}

Turn URL filtering rule on or off

Enable or disable a URL filtering rule, leaving the rest of it as it is. Takes effect once changes are activated.

Inputs

URL filtering rulerule_idtextRequired
The rule. Pick one, or give its id.
StatestatetextRequired
Enabled to turn the rule on, Disabled to turn it off.One of: ENABLED, DISABLED.

Outputs

changedtrue/false
False when the rule was already in that state
notetext
Whether the change waits for activation, or that nothing changed
ruleobject
The rule as it is now
Example output
{
  "changed": true,
  "note": "Saved in Zscaler. It reaches traffic once changes are activated: run 'Activate changes', or activate them in the Zscaler Admin Console.",
  "rule": {
    "action": "BLOCK",
    "departments": [
      {
        "id": 81896,
        "name": "Sales"
      }
    ],
    "description": "No gambling sites at work",
    "groups": [],
    "id": 1203,
    "lastModifiedBy": {
      "id": 4512,
      "name": "admin@example.com"
    },
    "lastModifiedTime": 1762905600,
    "locations": [],
    "name": "Block gambling",
    "order": 1,
    "protocols": [
      "HTTPS_RULE",
      "HTTP_RULE"
    ],
    "rank": 7,
    "requestMethods": [
      "GET",
      "POST"
    ],
    "state": "ENABLED",
    "urlCategories": [
      "GAMBLING"
    ],
    "users": []
  }
}

On this page