Skip to main content

Cyware Orchestrate

Zscaler Internet Access 1.0.0

App Vendor: Zscaler

App Category: Network Security

Connector Version: 1.0.1

API Version: 1.0.0

About App

The Zscaler Internet Access app allows security teams to integrate with the Zscaler Internet Access enterprise application, a secure internet and web gateway. The App provides network security through Actions that permit management access to URLs.

The Zscaler Internet Access app in the Orchestrate application can perform the below-listed actions:

Action Name

Description

URL lookup

This action performs a lookup for URLs.

Remove URLs from blacklisting

This action removes a list of URLs from blacklisting.

Get a list of URL categories

This action retrieves a list of URL categories.

Add URLs to a blacklist

This action adds a list of URLs to be blacklisted.

Get a list of blacklisted URLs

This action retrieves a list of blacklisted URLs.

Get a list of whitelisted URLs

This action retrieves a list of whitelisted URLs.

Get details of the cloud Sandbox report

This action retrieves details of a specific cloud Sandbox report using MD5Hash.

Add Exempted URLs

This action adds a list of URLs to be exempted from SSL scanning.

Add URLs to Whitelist

This action adds a list of URLs to be whitelisted.

Get Exempted URLs

This action adds a list of URLs to be exempted from SSL scanning.

Prerequisites

All the actions configured in the Zscaler Internet Access app relate to private APIs. Zscaler Internet Access Enterprise subscription is required to access private APIs.

Configuration parameters

The following configuration parameters are required for the Zscaler Internet Access app to communicate with the Zscaler Internet Access enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Base URL

Enter the Base URL.

Example:<http[s]://base_url>

Text

Required

Username

Enter the Username for your Zscaler application.

Example:

"exampleusername"

Text

Required

Password

Enter the password for your Zscaler application.

Example:

"examplePassword"

Password

Required

API Key

Enter the API key for the Zscaler API endpoint.

Example:

"soo9iXXXXXUs"

Password

Required

Action: Add Exempted URLs

This action adds a list of URLs to be exempted from SSL scanning.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

URL List

Enter the URL list to add to Zscaler.

Example:

["http://www.example.com" , "https://www.example1.com"]

Any

Required

Example Request
[
    {
        "url_list": [
            "http://www.example.com",
            "https://www.example1.com" 
        ]
    }
]
Action: Add URLs to a blacklist

This action adds a list of URLs to be blacklisted.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

URLs

Enter the URL values as comma separated list.

Example:

["http://www.example.com", "http://www.example1.com"]

Any

Required

Example Request
[
    {
        "url_list": [
            "http://www.example.com",
            "https://www.example1.com" 
        ]
    }
]
Action: Add URLs to Whitelist

This action adds a list of URLs to be whitelisted.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

URL List

Enter the URL list to add to Zscaler.

Example:

"[http://www.example.com , https://www.example1.com]"

Any

Required

Example Request
[
    {
        "url_list": [
            "http://www.example.com",
            "https://www.example1.com" 
        ]
    }
]
Action: Get a list of blacklisted URLs

This action retrieves a list of blacklisted URLs.

Input Parameters

Input parameters are not required for this action.

Action: Get a list of URL categories

This action retrieves a list of URL categories.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Custom URL categories only

Specify your optional preference to filter only custom URL categories or all URL categories.

Example:

"True"

Boolean

Optional

Allowed values:

  • True

  • False

Default value:

  • False

Example Request
[
    {
        "custom_only": "False"
    }
]
Action: Get a list of whitelisted URLs

This action retrieves a list of whitelisted URLs.

Input Parameters

Input parameters are not required for this action.

Action: Get details of the cloud Sandbox report

This action retrieves details of a specific cloud Sandbox report using MD5Hash.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Report MD5Hash

Enter the Report MD5Hash as Report UID.

Example:

"b3bxx2fe5710xxxxxx2106cb1xxxxxd3"

Text

Required

Example Request
[
    {
        "md5hash": "b3b13xxxxxfe5710xxxxb11ceced3"
    }
]
Action: Get Exempted URLs

This action adds a list of URLs to be exempted from SSL scanning.

Input Parameters

Input parameters are not required for this action.

Action: Remove URLs from blacklisting

This action removes a list of URLs from blacklisting.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

URLs

Enter the URL values as comma separated list.

Example:

["http://www.example.com", "http://www.example1.com"]

Any

Required

Example Request
[
    {
        "url_list": [
            "http://www.example1.com",
            "https://www.example1.com" 
        ]
    }
]
Action: URL Lookup

This action performs a lookup for URLs.

Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

URLs

Enter the URL values separated by commas.

Example:

https://www.example.com/

Any

Required

Example Request
[
    {
        "url_list": [
            "http://www.example.com",
            "https://www.example.com" 
        ]
    }
]