---
title: SkyHigh Security Secure Web Gateway
slug: connectors/skyhigh-security-secure-web-gateway
docTags: 
createdAt: 2026-06-09T16:29:53.930Z
---

The SkyHigh Security Secure Web Gateway connector enables automated interactions with the SkyHigh security platform, facilitating advanced threat protection and policy enforcement.

SkyHigh Security Secure Web Gateway is a comprehensive web security solution that provides advanced threat protection, data security, and compliance capabilities. This connector enables Swimlane Turbine users to automate web security management tasks such as adding or removing entries from lists, committing changes, and retrieving list information. By integrating with SkyHigh Security Secure Web Gateway, users can streamline their security operations, enforce policies, and respond to threats more efficiently within the Swimlane ecosystem.

## Prerequisites

To effectively utilize the SkyHigh Security Secure Web Gateway connector within Swimlane Turbine, ensure you have the following prerequisites:

- HTTP Basic Authentication with the following parameters:
  - URL: The endpoint URL for the SkyHigh Security Secure Web Gateway API.
  - Username: Your SkyHigh Security Secure Web Gateway username.
  - Password: Your SkyHigh Security Secure Web Gateway password.

## Capabilities

The SkyHigh Security Secure Web Gateway Connector has the following capabilities:

- Add Entry List
- Commit
- Delete Entry List
- Get List by ID
- Get Lists
- Logging Off
- Retrieving a List Entry
- Retrieving a List of List Entries

## Notes

- You cannot modify system lists. The task will fail with an 'unparsable xml' exception.
- If an account is logged in, you can't use it for anything until it logs out, or the timeout period expires. That means multiple tasks can't be run parallel without multiple users.
- The task will fail if you add entries that already exists on a list.
- The task will fail if you delete an entry that doesn't exists on a list.
- To delete an entry from the list, the position field should be specified as i−1. For example, to delete the third entry, you should specify 2.
- For the **add\_entry\_list** and **delete\_entry\_list** actions, changes will be automatically committed.
- [SkyHigh Security Secure Web Gateway API Documentation](https://success.skyhighsecurity.com/Skyhigh_Secure_Web_Gateway_\(On_Prem\)/REST_Interface/Working_with_lists)

# Configurations

## SkyHigh Security HTTP Basic Authentication

Authenticates using username and password.

### Configuration Parameters

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

# Actions

## Add Entry To List

Adds a specified entry to a list in SkyHigh Security Secure Web Gateway using the list ID and position.

### Endpoint

- **URL:** `/list/{{list_id}}/entry/{{position}}/insert`
- **Method:** `POST`

### Input

| **Argument Name**          | **Type** | **Required** | **Description**                             |
| -------------------------- | -------- | ------------ | ------------------------------------------- |
| `path_parameters.list_id`  | string   | Required     | Parameters for the Add Entry To List action |
| `path_parameters.position` | number   | Required     | Parameters for the Add Entry To List action |
| `entry`                    | string   | Required     | The entry to add.                           |
| `description`              | string   | Optional     | The description for the entry.              |

### Input Example

`{"path_parameters":{"list_id":"com.scur.type.regex.4537","position":2}}`

### 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-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

## Commit

Apply pending configuration changes to the SkyHigh Security Secure Web Gateway.

### Endpoint

- **URL:** `/commit`
- **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-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

## Delete Entry List

Removes a specified entry from a list in SkyHigh Security Secure Web Gateway using the list ID and position.

### Endpoint

- **URL:** `/list/{{list_id}}/entry/{{position}}`
- **Method:** `DELETE`

### Input

| **Argument Name**          | **Type** | **Required** | **Description**                 |
| -------------------------- | -------- | ------------ | ------------------------------- |
| `path_parameters.list_id`  | string   | Required     | List identifier.                |
| `path_parameters.position` | number   | Required     | Position of an entry in a list. |

### Input Example

`{"path_parameters":{"list_id":"com.scur.type.regex.4537","position":2}}`

### 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-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

## Get List by ID.

Retrieves detailed information for a specified list using its unique identifier (list ID) in SkyHigh Security Secure Web Gateway.

### Endpoint

- **URL:** `/list/{{list_id}}`
- **Method:** `GET`

### Input

| **Argument Name**         | **Type** | **Required** | **Description**  |
| ------------------------- | -------- | ------------ | ---------------- |
| `path_parameters.list_id` | string   | Required     | List identifier. |

### Input Example

`{"path_parameters":{"list_id":"com.scur.type.regex.4537"}}`

### 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-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

## Get Lists

Obtain a comprehensive collection of lists from SkyHigh Security Secure Web Gateway for further analysis or action.

### Endpoint

- **URL:** `/list`
- **Method:** `GET`

### Input

| **Argument Name**     | **Type** | **Required** | **Description**                                  |
| --------------------- | -------- | ------------ | ------------------------------------------------ |
| `parameters.type`     | string   | Optional     | List type.                                       |
| `parameters.name`     | string   | Optional     | Name of a list.                                  |
| `parameters.page`     | number   | Optional     | Number of a page in a feed with a list of lists. |
| `parameters.pageSize` | number   | Optional     | Size of a page in a feed.                        |

### Input Example

`{"parameters":{"type":"ip","name":"None","page":1,"pageSize":-1}}`

### 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-length":"140","content-type":"application/json","Date":"Mon, 10 Jul 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

## Retrieving a List Entry

Retrieve a specific entry from a list in SkyHigh Security Secure Web Gateway using the list ID and position.

### Endpoint

- **URL:** `/list/{{list_id}}/entry/{{position}}`
- **Method:** `GET`

### Input

| **Argument Name**          | **Type** | **Required** | **Description**                                                                                                 |
| -------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------- |
| `path_parameters.list_id`  | string   | Required     | List identifier.                                                                                                |
| `path_parameters.position` | number   | Required     | Position of an entry in a list. The position is specified as i –1. For example, for the third entry, specify 2. |

### Input Example

`{"path_parameters":{"list_id":"com.scur.type.regex.4537","position":2}}`

### 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-length":"140","content-type":"application/json","Date":"Sun, 17 May 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

## Retrieving a List of List Entries

Retrieve all entries from a specified list in SkyHigh Security Secure Web Gateway using the list ID.

### Endpoint

- **URL:** `/list/{{list_id}}/entry`
- **Method:** `GET`

### Input

| **Argument Name**         | **Type** | **Required** | **Description**                               |
| ------------------------- | -------- | ------------ | --------------------------------------------- |
| `path_parameters.list_id` | string   | Required     | List identifier.                              |
| `parameters.page`         | number   | Optional     | Number of a page in a feed with list entries. |
| `parameters.pageSize`     | number   | Optional     | Size of a page in a feed.                     |

### Input Example

`{"parameters":{"page":1,"pageSize":-1},"path_parameters":{"list_id":"com.scur.type.regex.4537"}}`

### 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-length":"140","content-type":"application/json","Date":"Sun, 17 May 2023 20:37:23 GMT"},"reason":"OK","json_body":{}}`

# Response Headers

| **Header**     | **Description**                                       | **Example**                   |
| -------------- | ----------------------------------------------------- | ----------------------------- |
| content-length | The length of the response body in bytes              | 140                           |
| content-type   | The media type of the resource                        | application/json              |
| Date           | The date and time at which the message was originated | Mon, 10 Jul 2023 20:37:23 GMT |