---
title: Zscaler Security
slug: connectors/zscaler-security
docTags: 
createdAt: 2026-06-09T16:29:49.664Z
---

The Zscaler Security connector enables seamless integration of Zscaler's cloud-based security services with Swimlane's automation capabilities, facilitating real-time policy management and threat intelligence.

Zscaler Security is a cloud-based information security platform that offers comprehensive protection against cyber threats. This connector enables Swimlane Turbine users to automate Zscaler policy management and threat response, streamlining security operations. By integrating with Zscaler Security, users can instantly apply configuration changes, manage firewall rules, and update URL categories, enhancing their security posture with minimal manual intervention.

## Prerequisites

To effectively utilize the Zscaler Security connector within Swimlane Turbine, ensure you have the following prerequisites:

- Client Credentials and Tenant ID authentication with these parameters:
  - URL: The endpoint URL for Zscaler API services.
  - Client ID: Your unique identifier for Zscaler API access.
  - Client Secret: A secret key associated with your Client ID for authentication.
  - Tenant ID: The identifier for your specific Zscaler tenant instance.
  - Scope: The scope of access requested for the API token.
- API Key authentication with these parameters:
  - URL: The endpoint URL for Zscaler API services.
  - Username: Your Zscaler account username.
  - Password: Your Zscaler account password.
  - API Token: A unique token generated for API access.

## Client Credential Flow Authentication

Authentication uses Zscaler's OAuth 2.0 client credentials flow via the ZIdentity platform.

In order to set up the asset, you need the following:

- **URL**: The base URL for your Zscaler tenant (e.g. `https://zsapi.zscaler.net`)
- **Client ID**: The client ID generated in your Zscaler ZIdentity admin portal
- **Client Secret**: The client secret associated with your client ID
- **Tenant ID**: Your Zscaler tenant domain (e.g. `example.zslogin.net`)
- **Scope**: The OAuth scope required for API access (e.g. `openid offline_access`)

For step-by-step setup instructions, see the [Zscaler Security Authentication Guide](https://docs.swimlane.com/authentication-guides/zscaler-security).

## Capabilities

The Zscaler connector has the following capabilities:

- Activate Changes
- Block URLs
- Unblock URLs
- Create URL Category
- Get URL Category
- Get MD5 Report
- Update URL Category
- URL Lookup
- Add URL to Category
- Remove URL from Category
- Get Firewall Filtering Policy Rules
- Add Firewall Filtering Policy Rule
- Update Firewall Filtering Policy Rule
- Delete Firewall Filtering Policy Rule
- Add IP Source Group
  *... and so on*

## Actions Setup

### Firewall and IP Destination actions

The following actions have enumerated inputs types:

- Add Firewall Filtering Policy Rule
- Update Firewall Filtering Policy Rule
- Add IP Destination Group
- Update IP Destination Group

You can find listed below all the possible values for the following inputs:

### Destination IP Categories

- ANY
- NONE
- OTHER\_ADULT\_MATERIAL
- ADULT\_THEMES
- LINGERIE\_BIKINI
- NUDITY
- PORNOGRAPHY
- SEXUALITY
- ADULT\_SEX\_EDUCATION
- K\_12\_SEX\_EDUCATION
- SOCIAL\_ADULT
- OTHER\_THREAT
- PHISHING
- BOTNET
- MALWARE\_SITE
  *... and so on*

### Destination Countries

- ANY
- NONE
- COUNTRY\_AD
- COUNTRY\_AE
- COUNTRY\_AF
- COUNTRY\_AG
- COUNTRY\_AI
- COUNTRY\_AL
- COUNTRY\_AM
- COUNTRY\_AN
- COUNTRY\_AO
- COUNTRY\_AQ
- COUNTRY\_AR
- COUNTRY\_AS
- COUNTRY\_AT
  *... and so on*

### Network Service actions

Below are listed all the possible values for enumerated inputs types
for `Add Network Service` and `Update Network Service` actions.

### Tag

- ICMP\_ANY
- UDP\_ANY
- TCP\_ANY
- OTHER\_NETWORK\_SERVICE
- DNS
- NETBIOS
- FTP
- GNUTELLA
- H\_323
- HTTP
- HTTPS
- IKE
- IMAP
- ILS
- IKE\_NAT
  *... and so on*

## Notes

- After modifying any configurations, you must activate the changes by using the **Activate Changes** action. For more details, click [here](https://help.zscaler.com/zia/getting-started-zia-api#ActivateChanges).
- [Zscaler API Reference](https://help.zscaler.com/zia/api#/)

# Configurations

## API Key Authentication

Authenticates using an API Key

### Configuration Parameters

| **Parameter** | **Description**                    | **Type** | **Required** |
| ------------- | ---------------------------------- | -------- | ------------ |
| url           | A URL to the target host.          | string   | Required     |
| username      | Username                           | string   | Required     |
| secret        | Password                           | string   | Required     |
| api\_key      | API Token                          | string   | Required     |
| verify\_ssl   | Verify SSL certificate             | boolean  | Optional     |
| http\_proxy   | A proxy to route requests through. | string   | Optional     |

## Zscaler Microsoft Graph API Asset - Tenant ID

Authenticates using Client Credentials and Tenant ID

### Configuration Parameters

| **Parameter**  | **Description**                            | **Type** | **Required** |
| -------------- | ------------------------------------------ | -------- | ------------ |
| url            | A URL to the target host.                  | string   | Required     |
| tenant\_id     | The Tenant ID.                             | string   | Required     |
| client\_ID     | The client ID                              | string   | Required     |
| client\_Secret | The client secret.                         | string   | Required     |
| scope          | List of permission scopes for this action. | array    | Required     |
| verify\_ssl    | Verify SSL certificate                     | boolean  | Optional     |
| http\_proxy    | A proxy to route requests through.         | string   | Optional     |

# Actions

## Activate Configuration Changes

Applies the latest configuration changes in Zscaler Security to ensure they take immediate effect.

### Endpoint

- **URL:** `api/v1/status/activate`
- **Method:** `POST`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |
| `status`      | string   | Status value                     |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Content-Disposition":"attachment; filename=\"api.json\"","x-zscaler-mode":"read-write","Cache-Control":"no-store, no-cache","Content-Type":"application/json","Content-Length":"19","Date":"Wed, 13 Mar 2024 18:34:56 GMT","Server":"Zscaler"},"reason":"","json_body":{"status":"ACTIVE"}}`

## Add Firewall Filtering Policy Rule

Create a new firewall filtering policy rule in Zscaler Security, specifying name, order, action, and rank.

### Endpoint

- **URL:** `api/v1/firewallFilteringRules`
- **Method:** `POST`

### Input

| **Argument Name** | **Type** | **Required** | **Description**                                  |
| ----------------- | -------- | ------------ | ------------------------------------------------ |
| `name`            | string   | Optional     | Name of the resource                             |
| `order`           | number   | Optional     | Parameter for Add Firewall Filtering Policy Rule |
| `rank`            | number   | Optional     | Parameter for Add Firewall Filtering Policy Rule |
| `defaultRule`     | boolean  | Optional     | Parameter for Add Firewall Filtering Policy Rule |
| `predefined`      | boolean  | Optional     | Parameter for Add Firewall Filtering Policy Rule |
| `action`          | string   | Optional     | Parameter for Add Firewall Filtering Policy Rule |

### Input Example

`{"json_body":{"name":"IP Group Source 711","order":1,"rank":0,"defaultRule":false,"predefined":false,"action":"ALLOW"}}`

### Output

| **Parameter**             | **Type** | **Description**                  |
| ------------------------- | -------- | -------------------------------- |
| `status_code`             | number   | HTTP status code of the response |
| `reason`                  | string   | Response reason phrase           |
| `enableFullLogging`       | boolean  | Output field: enableFullLogging  |
| `id`                      | number   | Unique identifier                |
| `name`                    | string   | Name of the resource             |
| `order`                   | number   | Output field: order              |
| `rank`                    | number   | Output field: rank               |
| `action`                  | string   | Output field: action             |
| `state`                   | string   | Output field: state              |
| `destIpCategories`        | array    | Output field: destIpCategories   |
| `destCountries`           | array    | Output field: destCountries      |
| `destCountries.file_name` | string   | Name of the resource             |
| `destCountries.file`      | string   | Output field: destCountries.file |
| `predefined`              | boolean  | Output field: predefined         |
| `defaultRule`             | boolean  | Output field: defaultRule        |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"207","Date":"Tue, 29 Nov 2022 21:31:19 GMT","Server":"Zscaler"},"reason":"","json_body":{"enableFullLogging":false,"id":...`

## Add IP Destination Group

Adds a new IP Destination group to Zscaler Security for efficient management of IP address collections.

### Endpoint

- **URL:** `api/v1/ipDestinationGroups`
- **Method:** `POST`

### Input

| **Argument Name** | **Type** | **Required** | **Description**                        |
| ----------------- | -------- | ------------ | -------------------------------------- |
| `name`            | string   | Optional     | Name of the resource                   |
| `type`            | string   | Optional     | Type of the resource                   |
| `addresses`       | array    | Optional     | Parameter for Add IP Destination Group |
| `description`     | string   | Optional     | Parameter for Add IP Destination Group |
| `ipCategories`    | array    | Optional     | Parameter for Add IP Destination Group |
| `countries`       | array    | Optional     | Parameter for Add IP Destination Group |
| `isNonEditable`   | boolean  | Optional     | Parameter for Add IP Destination Group |

### Input Example

`{"json_body":{"name":"test","type":"DSTN_IP","addresses":["1.0.0.0"],"description":"string","ipCategories":["CUSTOM_01"],"countries":["COUNTRY_BD"],"isNonEditable":true}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `id`            | number   | Unique identifier                |
| `name`          | string   | Name of the resource             |
| `type`          | string   | Type of the resource             |
| `addresses`     | array    | Output field: addresses          |
| `description`   | string   | Output field: description        |
| `ipCategories`  | array    | Output field: ipCategories       |
| `countries`     | array    | Output field: countries          |
| `isNonEditable` | boolean  | Output field: isNonEditable      |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"170","Date":"Tue, 29 Nov 2022 19:06:37 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":17531270,"name":"test","ty...`

## Add IP Source Group

Adds a new IP source group to Zscaler Security using the specified name in the JSON body.

### Endpoint

- **URL:** `api/v1/ipSourceGroups`
- **Method:** `POST`

### Input

| **Argument Name** | **Type** | **Required** | **Description**                   |
| ----------------- | -------- | ------------ | --------------------------------- |
| `name`            | string   | Optional     | Name of the resource              |
| `ipAddresses`     | array    | Optional     | Parameter for Add IP Source Group |
| `description`     | string   | Optional     | Parameter for Add IP Source Group |
| `isNonEditable`   | boolean  | Optional     | Parameter for Add IP Source Group |

### Input Example

`{"json_body":{"name":"unique name in here","ipAddresses":["1.0.0.0"],"description":"a description","isNonEditable":false}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `id`            | number   | Unique identifier                |
| `name`          | string   | Name of the resource             |
| `ipAddresses`   | array    | Output field: ipAddresses        |
| `description`   | string   | Output field: description        |
| `isNonEditable` | boolean  | Output field: isNonEditable      |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"122","Date":"Tue, 29 Nov 2022 20:13:49 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":17531274,"name":"unique na...`

## Add Network Service

Create a new network service in Zscaler Security by specifying at least one destination TCP or UDP port.

### Endpoint

- **URL:** `api/v1/networkServices`
- **Method:** `POST`

### Input

| **Argument Name**       | **Type** | **Required** | **Description**                   |
| ----------------------- | -------- | ------------ | --------------------------------- |
| `name`                  | string   | Optional     | Name of the resource              |
| `srcTcpPorts`           | array    | Optional     | Parameter for Add Network Service |
| `srcTcpPorts.file_name` | string   | Required     | Name of the resource              |
| `srcTcpPorts.file`      | string   | Required     | Parameter for Add Network Service |
| `destTcpPorts`          | array    | Optional     | Parameter for Add Network Service |
| `destTcpPorts.start`    | number   | Optional     | Parameter for Add Network Service |
| `destTcpPorts.end`      | number   | Optional     | Parameter for Add Network Service |
| `type`                  | string   | Optional     | Type of the resource              |
| `creatorContext`        | string   | Optional     | Parameter for Add Network Service |
| `isNameL10nTag`         | boolean  | Optional     | Name of the resource              |
| `srcUdpPorts`           | array    | Optional     | Parameter for Add Network Service |
| `srcUdpPorts.start`     | number   | Optional     | Parameter for Add Network Service |
| `srcUdpPorts.end`       | number   | Optional     | Parameter for Add Network Service |
| `destUdpPorts`          | array    | Optional     | Parameter for Add Network Service |
| `destUdpPorts.start`    | number   | Optional     | Parameter for Add Network Service |
| `destUdpPorts.end`      | number   | Optional     | Parameter for Add Network Service |
| `description`           | string   | Optional     | Parameter for Add Network Service |

### Input Example

`{"json_body":{"name":"renamed network service1234","srcTcpPorts":[],"destTcpPorts":[{"start":1,"end":100},{"start":200,"end":666}],"type":"CUSTOM","creatorContext":"ZIA","isNameL10nTag":false,"srcUdpPorts":[{"start":1,"end":2}],"destUdpPorts":[{"start":1,"end":2}],"description":"a description"}}`

### Output

| **Parameter**           | **Type** | **Description**                  |
| ----------------------- | -------- | -------------------------------- |
| `status_code`           | number   | HTTP status code of the response |
| `reason`                | string   | Response reason phrase           |
| `id`                    | number   | Unique identifier                |
| `name`                  | string   | Name of the resource             |
| `srcTcpPorts`           | array    | Output field: srcTcpPorts        |
| `srcTcpPorts.file_name` | string   | Name of the resource             |
| `srcTcpPorts.file`      | string   | Output field: srcTcpPorts.file   |
| `destTcpPorts`          | array    | Output field: destTcpPorts       |
| `destTcpPorts.start`    | number   | Output field: destTcpPorts.start |
| `destTcpPorts.end`      | number   | Output field: destTcpPorts.end   |
| `srcUdpPorts`           | array    | Output field: srcUdpPorts        |
| `srcUdpPorts.start`     | number   | Output field: srcUdpPorts.start  |
| `srcUdpPorts.end`       | number   | Output field: srcUdpPorts.end    |
| `destUdpPorts`          | array    | Output field: destUdpPorts       |
| `destUdpPorts.start`    | number   | Output field: destUdpPorts.start |
| `destUdpPorts.end`      | number   | Output field: destUdpPorts.end   |
| `type`                  | string   | Type of the resource             |
| `description`           | string   | Output field: description        |
| `creatorContext`        | string   | Output field: creatorContext     |
| `isNameL10nTag`         | boolean  | Name of the resource             |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"296","Date":"Tue, 29 Nov 2022 14:22:17 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":17531231,"name":"renamed n...`

## Blacklist URLs

Adds or removes URLs from the Zscaler denylist, requiring an 'action' parameter and a list of 'blacklistUrls'.

### Endpoint

- **URL:** `api/v1/security/advanced/blacklistUrls`
- **Method:** `POST`

### Input

| **Argument Name**   | **Type** | **Required** | **Description**                                                                                                |
| ------------------- | -------- | ------------ | -------------------------------------------------------------------------------------------------------------- |
| `parameters.action` | string   | Required     | The action applied to the Advanced Threat Protection policy’s denylist (i.e., adding a URL or removing a URL). |
| `blacklistUrls`     | array    | Optional     | URLs on the denylist for your organization. Allow up to 25000 URLs.                                            |

### Input Example

`{"parameters":{"action":"ADD_TO_LIST"},"json_body":{"blacklistUrls":["www.google.com"]}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `blacklistUrls` | array    | URL endpoint for the request     |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json","Content-Length":"160","Connection":"keep-alive","Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Cache-Control":"no-store, no-cache","Content-Disposition":"attachment; filename=\"api.json\"","x-zscaler-mode":"read-write","Date":"Fri, 13 Sep 2024 13:39:32 GMT","Server":"Zscaler","X-Cache":"Miss from ...`

## Create URL Category

Creates a new URL category within Zscaler Security using the provided ID in the JSON body input.

### Endpoint

- **URL:** `api/v1/urlCategories`
- **Method:** `POST`

### Input

| **Argument Name**                           | **Type** | **Required** | **Description**                   |
| ------------------------------------------- | -------- | ------------ | --------------------------------- |
| `id`                                        | string   | Optional     | Unique identifier                 |
| `superCategory`                             | string   | Optional     | Parameter for Create URL Category |
| `configuredName`                            | string   | Optional     | Name of the resource              |
| `keywords`                                  | array    | Optional     | Parameter for Create URL Category |
| `keywordsRetainingParentCategory`           | array    | Optional     | Parameter for Create URL Category |
| `urls`                                      | array    | Optional     | URL endpoint for the request      |
| `dbCategorizedUrls`                         | array    | Optional     | URL endpoint for the request      |
| `customCategory`                            | boolean  | Optional     | Parameter for Create URL Category |
| `editable`                                  | boolean  | Optional     | Parameter for Create URL Category |
| `description`                               | string   | Optional     | Parameter for Create URL Category |
| `type`                                      | string   | Optional     | Type of the resource              |
| `urlKeywordCounts`                          | object   | Optional     | URL endpoint for the request      |
| `urlKeywordCounts.totalUrlCount`            | number   | Optional     | URL endpoint for the request      |
| `urlKeywordCounts.retainParentUrlCount`     | number   | Optional     | URL endpoint for the request      |
| `urlKeywordCounts.totalKeywordCount`        | number   | Optional     | URL endpoint for the request      |
| `urlKeywordCounts.retainParentKeywordCount` | number   | Optional     | URL endpoint for the request      |
| `customUrlsCount`                           | number   | Optional     | URL endpoint for the request      |

### Input Example

`{"json_body":{"id":"ANY","superCategory":"NEWS_AND_MEDIA","configuredName":"string","keywords":["string"],"keywordsRetainingParentCategory":["OTHER_ADULT_MATERIAL"],"urls":["https://myurl.com"],"dbCategorizedUrls":["string"],"customCategory":false,"editable":false,"description":"string","type":"URL_CATEGORY","urlKeywordCounts":{"totalUrlCount":1,"retainParentUrlCount":1,"totalKeywordCount":1,"retainParentKeywordCount":1},"customUrlsCount":0}}`

### Output

| **Parameter**                          | **Type** | **Description**                               |
| -------------------------------------- | -------- | --------------------------------------------- |
| `status_code`                          | number   | HTTP status code of the response              |
| `reason`                               | string   | Response reason phrase                        |
| `id`                                   | string   | Unique identifier                             |
| `configuredName`                       | string   | Name of the resource                          |
| `superCategory`                        | string   | Output field: superCategory                   |
| `keywords`                             | array    | Output field: keywords                        |
| `keywords.file_name`                   | string   | Name of the resource                          |
| `keywords.file`                        | string   | Output field: keywords.file                   |
| `keywordsRetainingParentCategory`      | array    | Output field: keywordsRetainingParentCategory |
| `urls`                                 | array    | URL endpoint for the request                  |
| `urls.file_name`                       | string   | URL endpoint for the request                  |
| `urls.file`                            | string   | URL endpoint for the request                  |
| `dbCategorizedUrls`                    | array    | URL endpoint for the request                  |
| `dbCategorizedUrls.file_name`          | string   | URL endpoint for the request                  |
| `dbCategorizedUrls.file`               | string   | URL endpoint for the request                  |
| `customCategory`                       | boolean  | Output field: customCategory                  |
| `editable`                             | boolean  | Output field: editable                        |
| `description`                          | string   | Output field: description                     |
| `type`                                 | string   | Type of the resource                          |
| `val`                                  | number   | Output field: val                             |
| `customUrlsCount`                      | number   | URL endpoint for the request                  |
| `urlsRetainingParentCategoryCount`     | number   | URL endpoint for the request                  |
| `customIpRangesCount`                  | number   | Count value                                   |
| `ipRangesRetainingParentCategoryCount` | number   | Count value                                   |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"407","Date":"Tue, 29 Nov 2022 18:07:45 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":"CUSTOM_11","configuredNam...`

## Delete Firewall Filtering Policy Rule

Removes a specific firewall filtering policy rule from Zscaler Security using the provided rule ID.

### Endpoint

- **URL:** `api/v1/firewallFilteringRules/{{rule_id}}`
- **Method:** `DELETE`

### Input

| **Argument Name**         | **Type** | **Required** | **Description**                                                 |
| ------------------------- | -------- | ------------ | --------------------------------------------------------------- |
| `path_parameters.rule_id` | string   | Required     | Parameters for the Delete Firewall Filtering Policy Rule action |

### Input Example

`{"path_parameters":{"rule_id":"248300"}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `response_text` | string   | Output field: response\_text     |

### Output Example

`{"status_code":204,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Date":"Tue, 29 Nov 2022 21:36:53 GMT","Server":"Zscaler"},"reason":"","response_text":""}`

## Delete IP Destination Group

Removes a specified IP destination group from Zscaler Security using the provided unique ip\_group\_id.

### Endpoint

- **URL:** `api/v1/ipDestinationGroups/{{ip_group_id}}`
- **Method:** `DELETE`

### Input

| **Argument Name**             | **Type** | **Required** | **Description**                                       |
| ----------------------------- | -------- | ------------ | ----------------------------------------------------- |
| `path_parameters.ip_group_id` | string   | Required     | Parameters for the Delete IP Destination Group action |

### Input Example

`{"path_parameters":{"ip_group_id":"17478025"}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `response_text` | string   | Output field: response\_text     |

### Output Example

`{"status_code":204,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Date":"Tue, 29 Nov 2022 19:40:10 GMT","Server":"Zscaler"},"reason":"","response_text":""}`

## Delete IP Source Group

Removes a specified IP source group from Zscaler Security using the unique ip\_group\_id provided.

### Endpoint

- **URL:** `/api/v1/ipSourceGroups/{{ip_group_id}}`
- **Method:** `DELETE`

### Input

| **Argument Name**             | **Type** | **Required** | **Description**                                  |
| ----------------------------- | -------- | ------------ | ------------------------------------------------ |
| `path_parameters.ip_group_id` | string   | Required     | Parameters for the Delete IP Source Group action |

### Input Example

`{"path_parameters":{"ip_group_id":"14570789"}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `response_text` | string   | Output field: response\_text     |

### Output Example

`{"status_code":204,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Date":"Tue, 29 Nov 2022 20:18:10 GMT","Server":"Zscaler"},"reason":"","response_text":""}`

## Delete Network Service

Removes a specified network service from Zscaler Security using the provided network\_service\_id.

### Endpoint

- **URL:** `api/v1/networkServices/{{network_service_id}}`
- **Method:** `DELETE`

### Input

| **Argument Name**                    | **Type** | **Required** | **Description**                                  |
| ------------------------------------ | -------- | ------------ | ------------------------------------------------ |
| `path_parameters.network_service_id` | string   | Required     | Parameters for the Delete Network Service action |

### Input Example

`{"path_parameters":{"network_service_id":"14573795"}}`

### Output

| **Parameter**   | **Type** | **Description**                  |
| --------------- | -------- | -------------------------------- |
| `status_code`   | number   | HTTP status code of the response |
| `reason`        | string   | Response reason phrase           |
| `response_text` | string   | Output field: response\_text     |

### Output Example

`{"status_code":204,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Date":"Tue, 29 Nov 2022 14:16:27 GMT","Server":"Zscaler"},"reason":"","response_text":""}`

## Get Firewall Filtering Policy Rules

Retrieves all rules within the Firewall Filtering policy for a specified rule ID in Zscaler Security.

### Endpoint

- **URL:** `api/v1/firewallFilteringRules/{{rule_id}}`
- **Method:** `GET`

### Input

| **Argument Name**         | **Type** | **Required** | **Description**                                               |
| ------------------------- | -------- | ------------ | ------------------------------------------------------------- |
| `path_parameters.rule_id` | string   | Required     | Parameters for the Get Firewall Filtering Policy Rules action |
| `name`                    | string   | Optional     | Name of the resource                                          |

### Input Example

`{"json_body":{"name":"IP Group Source 7"},"path_parameters":{"rule_id":"13055202"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","vary":"accept-encoding","Content-Type":"application/json","Content-Length":"5462","Date":"Tue, 29 Nov 2022 20:54:52 GMT","Server":"Zscaler"},"reason":"","json_body":[{"acc...`

## Get IP Destination Groups

Retrieve details for a specific IP destination group in Zscaler Security using the provided unique group ID.

### Endpoint

- **URL:** `api/v1/ipDestinationGroups/{{ip_group_id}}`
- **Method:** `GET`

### Input

| **Argument Name**             | **Type** | **Required** | **Description**                                     |
| ----------------------------- | -------- | ------------ | --------------------------------------------------- |
| `path_parameters.ip_group_id` | string   | Required     | Parameters for the Get IP Destination Groups action |

### Input Example

`{"path_parameters":{"ip_group_id":"17478027"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","vary":"accept-encoding","Content-Type":"application/json","Content-Length":"2503","Date":"Tue, 29 Nov 2022 19:16:21 GMT","Server":"Zscaler"},"reason":"","json_body":[{"id"...`

## Get IP Source Groups

Retrieves a list of IP source groups from Zscaler Security using the specified ip\_group\_id for targeted information.

### Endpoint

- **URL:** `api/v1/ipSourceGroups/{{ip_group_id}}`
- **Method:** `GET`

### Input

| **Argument Name**             | **Type** | **Required** | **Description**                                |
| ----------------------------- | -------- | ------------ | ---------------------------------------------- |
| `path_parameters.ip_group_id` | string   | Required     | Parameters for the Get IP Source Groups action |

### Input Example

`{"path_parameters":{"ip_group_id":"14570789"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","vary":"accept-encoding","Content-Type":"application/json","Content-Length":"1461","Date":"Tue, 29 Nov 2022 19:48:09 GMT","Server":"Zscaler"},"reason":"","json_body":[{"id"...`

## Get Network Services

Retrieve a list of network services or specific service details from Zscaler Security, with optional filtering by service ID.

### Endpoint

- **URL:** `/api/v1/networkServices`
- **Method:** `GET`

### Input

| **Argument Name**    | **Type** | **Required** | **Description**   |
| -------------------- | -------- | ------------ | ----------------- |
| `network_service_id` | string   | Optional     | Unique identifier |

### Input Example

`{"network_service_id":"13303217"}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","vary":"accept-encoding","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Mon, 28 Nov 2022 20:35:40 GMT","Server":"Zscaler"},"reason":"","json_body":...`

## Get URL Categories

Retrieve and classify web content with a list of URL categories from Zscaler Security.

### Endpoint

- **URL:** `api/v1/urlCategories`
- **Method:** `GET`

### Input

| **Argument Name** | **Type** | **Required** | **Description** |
| ----------------- | -------- | ------------ | --------------- |
| `data_body`       | object   | Optional     | Data Body       |
| `headers`         | object   | Optional     | Request Headers |

### Input Example

`{"path_parameters":{},"parameters":{},"data_body":{},"headers":{}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","vary":"accept-encoding","Content-Type":"application/json","Transfer-Encoding":"chunked","Date":"Tue, 29 Nov 2022 15:41:09 GMT","Server":"Zscaler"},"reason":"","json_body":...`

## Sandbox Get MD5 Report

Retrieve a detailed sandbox report for a given MD5 hash from Zscaler Security, utilizing the 'md5' path parameter.

### Endpoint

- **URL:** `api/v1/sandbox/report/{{md5}}`
- **Method:** `GET`

### Input

| **Argument Name**     | **Type** | **Required** | **Description**                                  |
| --------------------- | -------- | ------------ | ------------------------------------------------ |
| `path_parameters.md5` | string   | Required     | Parameters for the Sandbox Get MD5 Report action |

### Input Example

`{"path_parameters":{"md5":"1f3870be274f6c49b3e31a0c6728957f"}}`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |
| `Summary`     | string   | Output field: Summary            |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"90","Date":"Tue, 29 Nov 2022 21:40:34 GMT","Server":"Zscaler"},"reason":"","json_body":{"Summary":"md5 is unknown or ana...`

## Update Firewall Filtering Policy Rule

Updates a Zscaler Security firewall filtering policy rule using the provided rule ID and parameters like name, action, order, and rank.

### Endpoint

- **URL:** `api/v1/firewallFilteringRules/{{rule_id}}`
- **Method:** `PUT`

### Input

| **Argument Name**         | **Type** | **Required** | **Description**                                                 |
| ------------------------- | -------- | ------------ | --------------------------------------------------------------- |
| `path_parameters.rule_id` | string   | Required     | Parameters for the Update Firewall Filtering Policy Rule action |
| `name`                    | string   | Optional     | Name of the resource                                            |
| `order`                   | number   | Optional     | Parameter for Update Firewall Filtering Policy Rule             |
| `rank`                    | number   | Optional     | Parameter for Update Firewall Filtering Policy Rule             |
| `defaultRule`             | boolean  | Optional     | Parameter for Update Firewall Filtering Policy Rule             |
| `predefined`              | boolean  | Optional     | Parameter for Update Firewall Filtering Policy Rule             |
| `action`                  | string   | Optional     | Parameter for Update Firewall Filtering Policy Rule             |

### Input Example

`{"json_body":{"name":"IP Group Source 71","order":1,"rank":0,"defaultRule":false,"predefined":false,"action":"ALLOW"},"path_parameters":{"rule_id":"248300"}}`

### Output

| **Parameter**             | **Type** | **Description**                  |
| ------------------------- | -------- | -------------------------------- |
| `status_code`             | number   | HTTP status code of the response |
| `reason`                  | string   | Response reason phrase           |
| `enableFullLogging`       | boolean  | Output field: enableFullLogging  |
| `id`                      | number   | Unique identifier                |
| `name`                    | string   | Name of the resource             |
| `order`                   | number   | Output field: order              |
| `rank`                    | number   | Output field: rank               |
| `action`                  | string   | Output field: action             |
| `state`                   | string   | Output field: state              |
| `destIpCategories`        | array    | Output field: destIpCategories   |
| `destCountries`           | array    | Output field: destCountries      |
| `destCountries.file_name` | string   | Name of the resource             |
| `destCountries.file`      | string   | Output field: destCountries.file |
| `predefined`              | boolean  | Output field: predefined         |
| `defaultRule`             | boolean  | Output field: defaultRule        |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"206","Date":"Tue, 29 Nov 2022 21:27:11 GMT","Server":"Zscaler"},"reason":"","json_body":{"enableFullLogging":false,"id":...`

## Update IP Destination Group

Updates an existing IP destination group in Zscaler Security using the specified group ID.

### Endpoint

- **URL:** `api/v1/ipDestinationGroups/{{ip_group_id}}`
- **Method:** `PUT`

### Input

| **Argument Name**             | **Type** | **Required** | **Description**                                       |
| ----------------------------- | -------- | ------------ | ----------------------------------------------------- |
| `path_parameters.ip_group_id` | string   | Required     | Parameters for the Update IP Destination Group action |
| `name`                        | string   | Optional     | Name of the resource                                  |
| `type`                        | string   | Optional     | Type of the resource                                  |
| `addresses`                   | array    | Optional     | Parameter for Update IP Destination Group             |
| `description`                 | string   | Optional     | Parameter for Update IP Destination Group             |
| `ipCategories`                | array    | Optional     | Parameter for Update IP Destination Group             |
| `countries`                   | array    | Optional     | Parameter for Update IP Destination Group             |
| `isNonEditable`               | boolean  | Optional     | Parameter for Update IP Destination Group             |

### Input Example

`{"json_body":{"name":"test","type":"DSTN_IP","addresses":["1.0.0.0"],"description":"string","ipCategories":["CUSTOM_01"],"countries":["COUNTRY_BD"],"isNonEditable":true},"path_parameters":{"ip_group_id":"17531270"}}`

### Output

| **Parameter**    | **Type** | **Description**                  |
| ---------------- | -------- | -------------------------------- |
| `status_code`    | number   | HTTP status code of the response |
| `reason`         | string   | Response reason phrase           |
| `id`             | number   | Unique identifier                |
| `name`           | string   | Name of the resource             |
| `type`           | string   | Type of the resource             |
| `addresses`      | array    | Output field: addresses          |
| `description`    | string   | Output field: description        |
| `creatorContext` | string   | Output field: creatorContext     |
| `ipCategories`   | array    | Output field: ipCategories       |
| `countries`      | array    | Output field: countries          |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"172","Date":"Tue, 29 Nov 2022 19:36:30 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":17531270,"name":"test","ty...`

## Update IP Source Group

Updates an existing IP source group in Zscaler Security using the specified IP group ID.

### Endpoint

- **URL:** `api/v1/ipSourceGroups/{{ip_group_id}}`
- **Method:** `PUT`

### Input

| **Argument Name**             | **Type** | **Required** | **Description**                                  |
| ----------------------------- | -------- | ------------ | ------------------------------------------------ |
| `path_parameters.ip_group_id` | string   | Required     | Parameters for the Update IP Source Group action |
| `name`                        | string   | Optional     | Name of the resource                             |
| `ipAddresses`                 | array    | Optional     | Parameter for Update IP Source Group             |
| `description`                 | string   | Optional     | Parameter for Update IP Source Group             |
| `isNonEditable`               | boolean  | Optional     | Parameter for Update IP Source Group             |

### Input Example

`{"json_body":{"name":"string","ipAddresses":["1.0.0.0"],"description":"anythings","isNonEditable":false},"path_parameters":{"ip_group_id":"14570789"}}`

### Output

| **Parameter**    | **Type** | **Description**                  |
| ---------------- | -------- | -------------------------------- |
| `status_code`    | number   | HTTP status code of the response |
| `reason`         | string   | Response reason phrase           |
| `id`             | number   | Unique identifier                |
| `name`           | string   | Name of the resource             |
| `ipAddresses`    | array    | Output field: ipAddresses        |
| `description`    | string   | Output field: description        |
| `creatorContext` | string   | Output field: creatorContext     |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"106","Date":"Tue, 29 Nov 2022 20:07:11 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":14570789,"name":"string","...`

## Update Network Service

Updates a specified network service in Zscaler Security using the provided network\_service\_id.

### Endpoint

- **URL:** `api/v1/networkServices/{{network_service_id}}`
- **Method:** `PUT`

### Input

| **Argument Name**                    | **Type** | **Required** | **Description**                                  |
| ------------------------------------ | -------- | ------------ | ------------------------------------------------ |
| `path_parameters.network_service_id` | string   | Required     | Parameters for the Update Network Service action |
| `name`                               | string   | Optional     | Name of the resource                             |
| `srcTcpPorts`                        | array    | Optional     | Parameter for Update Network Service             |
| `srcTcpPorts.file_name`              | string   | Required     | Name of the resource                             |
| `srcTcpPorts.file`                   | string   | Required     | Parameter for Update Network Service             |
| `destTcpPorts`                       | array    | Optional     | Parameter for Update Network Service             |
| `destTcpPorts.start`                 | number   | Optional     | Parameter for Update Network Service             |
| `destTcpPorts.end`                   | number   | Optional     | Parameter for Update Network Service             |
| `type`                               | string   | Optional     | Type of the resource                             |
| `creatorContext`                     | string   | Optional     | Parameter for Update Network Service             |
| `isNameL10nTag`                      | boolean  | Optional     | Name of the resource                             |
| `srcUdpPorts`                        | array    | Optional     | Parameter for Update Network Service             |
| `srcUdpPorts.start`                  | number   | Optional     | Parameter for Update Network Service             |
| `srcUdpPorts.end`                    | number   | Optional     | Parameter for Update Network Service             |
| `destUdpPorts`                       | array    | Optional     | Parameter for Update Network Service             |
| `destUdpPorts.start`                 | number   | Optional     | Parameter for Update Network Service             |
| `destUdpPorts.end`                   | number   | Optional     | Parameter for Update Network Service             |
| `description`                        | string   | Optional     | Parameter for Update Network Service             |

### Input Example

`{"json_body":{"name":"renamed this network service1234","srcTcpPorts":[],"destTcpPorts":[{"start":2,"end":100},{"start":201,"end":666}],"type":"CUSTOM","creatorContext":"ZIA","isNameL10nTag":false,"srcUdpPorts":[{"start":2,"end":3}],"destUdpPorts":[{"start":2,"end":3}],"description":"a description again"},"path_parameters":{"network_service_id":"17531231"}}`

### Output

| **Parameter**           | **Type** | **Description**                  |
| ----------------------- | -------- | -------------------------------- |
| `status_code`           | number   | HTTP status code of the response |
| `reason`                | string   | Response reason phrase           |
| `id`                    | number   | Unique identifier                |
| `name`                  | string   | Name of the resource             |
| `srcTcpPorts`           | array    | Output field: srcTcpPorts        |
| `srcTcpPorts.file_name` | string   | Name of the resource             |
| `srcTcpPorts.file`      | string   | Output field: srcTcpPorts.file   |
| `destTcpPorts`          | array    | Output field: destTcpPorts       |
| `destTcpPorts.start`    | number   | Output field: destTcpPorts.start |
| `destTcpPorts.end`      | number   | Output field: destTcpPorts.end   |
| `srcUdpPorts`           | array    | Output field: srcUdpPorts        |
| `srcUdpPorts.start`     | number   | Output field: srcUdpPorts.start  |
| `srcUdpPorts.end`       | number   | Output field: srcUdpPorts.end    |
| `destUdpPorts`          | array    | Output field: destUdpPorts       |
| `destUdpPorts.start`    | number   | Output field: destUdpPorts.start |
| `destUdpPorts.end`      | number   | Output field: destUdpPorts.end   |
| `type`                  | string   | Type of the resource             |
| `description`           | string   | Output field: description        |
| `creatorContext`        | string   | Output field: creatorContext     |
| `isNameL10nTag`         | boolean  | Name of the resource             |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"307","Date":"Tue, 29 Nov 2022 15:37:27 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":17531231,"name":"renamed t...`

## Update URL Category

Updates a specified URL category in Zscaler Security by adding or removing items, requiring the url\_category\_id and action parameters.

### Endpoint

- **URL:** `api/v1/urlCategories/{{url_category_id}}`
- **Method:** `PUT`

### Input

| **Argument Name**                           | **Type** | **Required** | **Description**                               |
| ------------------------------------------- | -------- | ------------ | --------------------------------------------- |
| `path_parameters.url_category_id`           | string   | Required     | Parameters for the Update URL Category action |
| `parameters.action`                         | string   | Required     | Parameters for the Update URL Category action |
| `configuredName`                            | string   | Optional     | Name of the resource                          |
| `keywords`                                  | array    | Optional     | Parameter for Update URL Category             |
| `keywordsRetainingParentCategory`           | array    | Optional     | Parameter for Update URL Category             |
| `urls`                                      | array    | Optional     | URL endpoint for the request                  |
| `dbCategorizedUrls`                         | array    | Optional     | URL endpoint for the request                  |
| `customCategory`                            | boolean  | Optional     | Parameter for Update URL Category             |
| `editable`                                  | boolean  | Optional     | Parameter for Update URL Category             |
| `description`                               | string   | Optional     | Parameter for Update URL Category             |
| `type`                                      | string   | Optional     | Type of the resource                          |
| `urlKeywordCounts`                          | object   | Optional     | URL endpoint for the request                  |
| `urlKeywordCounts.totalUrlCount`            | number   | Optional     | URL endpoint for the request                  |
| `urlKeywordCounts.retainParentUrlCount`     | number   | Optional     | URL endpoint for the request                  |
| `urlKeywordCounts.totalKeywordCount`        | number   | Optional     | URL endpoint for the request                  |
| `urlKeywordCounts.retainParentKeywordCount` | number   | Optional     | URL endpoint for the request                  |
| `customUrlsCount`                           | number   | Optional     | URL endpoint for the request                  |
| `urlsRetainingParentCategoryCount`          | number   | Optional     | URL endpoint for the request                  |
| `ipRangesRetainingParentCategoryCount`      | number   | Optional     | Count value                                   |

### Input Example

`{"parameters":{"action":"ADD_TO_LIST"},"json_body":{"configuredName":"string","keywords":["string"],"keywordsRetainingParentCategory":["string"],"urls":["www.google.com"],"dbCategorizedUrls":["www.google.com"],"customCategory":false,"editable":false,"description":"string","type":"URL_CATEGORY","urlKeywordCounts":{"totalUrlCount":0,"retainParentUrlCount":0,"totalKeywordCount":0,"retainParentKeywordCount":0},"customUrlsCount":0,"urlsRetainingParentCategoryCount":0,"ipRangesRetainingParentCategoryCount":0},"path_parameters":{"url_category_id":"LINGERIE_BIKINI"}}`

### Output

| **Parameter**                          | **Type** | **Description**                               |
| -------------------------------------- | -------- | --------------------------------------------- |
| `status_code`                          | number   | HTTP status code of the response              |
| `reason`                               | string   | Response reason phrase                        |
| `id`                                   | string   | Unique identifier                             |
| `keywords`                             | array    | Output field: keywords                        |
| `keywords.file_name`                   | string   | Name of the resource                          |
| `keywords.file`                        | string   | Output field: keywords.file                   |
| `keywordsRetainingParentCategory`      | array    | Output field: keywordsRetainingParentCategory |
| `urls`                                 | array    | URL endpoint for the request                  |
| `urls.file_name`                       | string   | URL endpoint for the request                  |
| `urls.file`                            | string   | URL endpoint for the request                  |
| `dbCategorizedUrls`                    | array    | URL endpoint for the request                  |
| `customCategory`                       | boolean  | Output field: customCategory                  |
| `editable`                             | boolean  | Output field: editable                        |
| `description`                          | string   | Output field: description                     |
| `type`                                 | string   | Type of the resource                          |
| `val`                                  | number   | Output field: val                             |
| `customUrlsCount`                      | number   | URL endpoint for the request                  |
| `urlsRetainingParentCategoryCount`     | number   | URL endpoint for the request                  |
| `customIpRangesCount`                  | number   | Count value                                   |
| `ipRangesRetainingParentCategoryCount` | number   | Count value                                   |

### Output Example

`{"status_code":200,"response_headers":{"Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","x-zscaler-mode":"read-write","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store","Content-Type":"application/json","Content-Length":"360","Date":"Tue, 29 Nov 2022 17:11:42 GMT","Server":"Zscaler"},"reason":"","json_body":{"id":"LINGERIE_BIKINI","keyword...`

## URL Lookup

Retrieve Zscaler's default classification for a specified set of URLs using the provided JSON body input.

### Endpoint

- **URL:** `/api/v1/urlLookup`
- **Method:** `POST`

### Output

| **Parameter** | **Type** | **Description**                  |
| ------------- | -------- | -------------------------------- |
| `status_code` | number   | HTTP status code of the response |
| `reason`      | string   | Response reason phrase           |

### Output Example

`{"status_code":200,"response_headers":{"Content-Type":"application/json","Content-Length":"233","Connection":"keep-alive","Strict-Transport-Security":"max-age=31622400;includeSubDomains;preload","X-Frame-Options":"SAMEORIGIN","X-Content-Type-Options":"nosniff","X-XSS-Protection":"1; mode=block","Content-Disposition":"attachment; filename=\"api.json\"","Cache-Control":"no-store, no-cache","x-zscaler-mode":"read-write","Date":"Thu, 26 Sep 2024 06:09:52 GMT","Server":"Zscaler","X-Cache":"Miss from ...`

# Response Headers

| **Header**                | **Description**                                          | **Example**                                                      |
| ------------------------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
| Alt-Svc                   | HTTP response header: Alt-Svc                            | h3=":443"; ma=86400                                              |
| Cache-Control             | Directives for caching mechanisms                        | no-store, no-cache                                               |
| Connection                | HTTP response header: Connection                         | keep-alive                                                       |
| Content-Disposition       | HTTP response header: Content-Disposition                | attachment; filename="api.json"                                  |
| Content-Length            | The length of the response body in bytes                 | 90                                                               |
| Content-Type              | The media type of the resource                           | application/json                                                 |
| Date                      | The date and time at which the message was originated    | Thu, 26 Sep 2024 06:09:52 GMT                                    |
| Server                    | Information about the software used by the origin server | Zscaler                                                          |
| Strict-Transport-Security | HTTP response header: Strict-Transport-Security          | max-age=31622400;includeSubDomains;preload                       |
| Transfer-Encoding         | HTTP response header: Transfer-Encoding                  | chunked                                                          |
| vary                      | HTTP response header: vary                               | accept-encoding                                                  |
| Via                       | HTTP response header: Via                                | 1.1 80b8b1b9b894db76db52fa97ad6ed63a.cloudfront.net (CloudFront) |
| X-Amz-Cf-Id               | HTTP response header: X-Amz-Cf-Id                        | dwq1MN\_6\_Tb7JYCia3eTJ4U0ScG\_HFDtr1G1ZOUnZakkxWzSyWtSCA==      |
| X-Amz-Cf-Pop              | HTTP response header: X-Amz-Cf-Pop                       | HYD57-P4                                                         |
| X-Cache                   | HTTP response header: X-Cache                            | Miss from cloudfront                                             |
| X-Content-Type-Options    | HTTP response header: X-Content-Type-Options             | nosniff                                                          |
| X-Frame-Options           | HTTP response header: X-Frame-Options                    | SAMEORIGIN                                                       |
| X-XSS-Protection          | HTTP response header: X-XSS-Protection                   | 1; mode=block                                                    |
| x-zscaler-mode            | HTTP response header: x-zscaler-mode                     | read-write                                                       |