Symantec Cloud Secure Web Gateway

Symantec Cloud Secure Web Gateway is a cloud-based security solution that protects against web threats and enforces internet usage policies.

Symantec Cloud Secure Web Gateway is a comprehensive security solution that provides advanced threat protection and policy management for web traffic. This connector allows Swimlane Turbine users to automate the management of policy lists, including creating, retrieving, updating, and deleting custom policy lists. By integrating with Symantec Cloud Secure Web Gateway, users can streamline policy enforcement, enhance security posture, and ensure compliance with organizational policies, all within the Swimlane Turbine platform.

Limitations

API credentials are only visible when first created in the Cloud SWG portal; store them securely. They cannot be edited or re-displayed later.

Each API key must be granted the correct Access roles in the portal (for example, Policy Management). Using credentials against an API whose role was not selected returns 403 Forbidden with an invalid-credentials style message.

Rate limits apply per the Policy Management API: many methods are limited to 6 requests per minute (refilled on 60-second intervals). The publish operation has a stricter default limit (1 request per 15 minutes).

Endpoints and behavior follow Broadcom’s published API reference; regional or tenant-specific base URLs may differ from the default portal host.

Supported Version

This connector targets the Policy Management REST API as documented in Broadcom Tech Docs (Swagger info.version 1.0 in the policy reference). Authentication uses HTTP Basic with the API username and password pair generated under Account Configuration → API Credentials in the Cloud SWG portal.

Configuration

Prerequisites

Before you can use the Symantec Cloud Secure Web Gateway connector for Turbine, you'll need access to the Symantec Cloud SWG API. This requires the following:

HTTP Basic authentication using Cloud SWG API username and password from Account Configuration, API Credentials.

URL: The endpoint for accessing the Symantec Cloud SWG API.

API Username: Your account's API username for authentication.

API Password: Your account's API password for authentication.

Authentication Methods

HTTP Basic (API username and password)

Cloud SWG APIs authenticate with the API Username as the Basic auth username and the API Password as the Basic auth password—the same pattern as:

curl -u "<API_USERNAME>:<API_PASSWORD>" -X GET "https://portal.threatpulse.com/api/rest/policy/listTypes"

Setup instructions:

Open Account Configuration → API Credentials.

Click Add API Credentials and copy the generated Username and Password immediately.

Set Expiry (time-based or never) and assign Access roles that include Policy Management for list and publish operations.

In the Turbine asset, set URL to your REST base (default https://portal.threatpulse.com/api/rest, no trailing slash after rest), then paste API Username and API Password.

Document references:

API authentication (API keys)

Cloud SWG API reference (overview)

Policy Management API reference

Troubleshooting tips

403 Forbidden / invalid credentials: Confirm the API key’s Access roles include the API family you are calling, and that the username and password match the pair saved at creation time.

404 on list type or list: Verify the list type or list id exists for the tenant and that the path is correct relative to the configured URL (policy paths should not repeat /api/rest in individual actions if the asset URL already ends with /api/rest).

Capabilities

This connector provides comprehensive integration with the Cloud SWG Policy Management API, supporting full CRUD and operational management of custom policy lists, list types, and publish operations.

Get Policy List Types

List Policy Lists

Create Policy List

Get Policy List By ID

Replace Policy List Contents

Append Policy List Items

Delete Policy List

Publish Policy

List Policy Object Catalog

Get Policy List Items by Type (paged)

Get Policy List Types

Returns the available custom policy list types that the customer can create or modify. This is useful for building UI dropdowns or validating input for list-related operations.

API Reference: Get Policy List Types

List Policy Lists

Lists all existing custom policy lists for the customer. You can filter results by type via query parameter. Useful to inventory current policy structures or identify lists for further action.

API Reference: List Policy Lists

Create Policy List

Creates a new custom policy list of a specified type. Input fields must include name, type, and may include an initial set of items and a comment.

API Reference: Create Policy List

Get Policy List By ID

Returns metadata and the current item set for a specific policy list. Use this to review or modify existing lists.

API Reference: Get Policy List By ID

Replace Policy List Contents

Completely replaces the items in an existing policy list using a PUT operation. Required fields include name, type, items, and optionally a comment.

API Reference: Replace Policy List Contents

Append Policy List Items

Adds one or more items to an existing policy list with a PATCH operation. This appends entries to the list without overwriting existing data.

API Reference: Append Policy List Items

Delete Policy List

Deletes a custom policy list by ID if it is no longer referenced by any active rule or policy.

API Reference: Delete Policy List

Publish Policy

Initiates the publish operation for the customer's current policy configuration. Note: The publish endpoint is rate-limited to one call per 15 minutes. Ensure prior changes have settled before invoking this operation.

API Reference: Publish Policy

List Policy Object Catalog / Items By Type

Retrieves a paginated list of available policy objects by their type—used when assembling, validating, or reviewing list membership. Supports type, page, and size query parameters for fine-grained control.

API Reference: List Policy Object Catalog

For additional detail on each endpoint and request schema, refer to the Policy Management API reference.

Asset setup

Configure the HTTP Basic asset with:

URL — REST base URL (default https://portal.threatpulse.com/api/rest).

API Username / API Password — From API Credentials in the Cloud SWG portal.

Verify SSL Certificates and HTTP(s) Proxy — Optional, per your environment.

Test connectivity with a read-only action such as Get Policy List Types before running mutating or publish operations.

Notes

Individual action names and input fields match the YAML definitions under connector/config/actions/.

For policy list usage examples beyond the REST reference, see Broadcom’s related topics linked from the Policy Management documentation (for example, policy list usage guides where published).

Configurations

HTTP Basic Authentication

HTTP Basic authentication using Cloud SWG API username and password from Account Configuration, API Credentials.

Configuration Parameters

Parameter	Description	Type	Required
url	Cloud SWG REST API base URL.	string	Required
username	API credential username shown when the key was created.	string	Required
password	API credential password shown when the key was created.	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Append Policy List Items

Appends entries to an existing published customer policy list in Symantec Cloud Secure Web Gateway. Requires the policy list ID as a path parameter.

Endpoint

URL: policy/lists/{{id}}

Method: PATCH

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Unique identifier of the custom policy list to update.
name	string	Optional	List display name as stored in policy management.
type	string	Optional	Policy list type identifier for this list resource.
comment	string	Optional	Optional comment describing list purpose or change reason.
items	array	Optional	New list entries to append without removing existing items.
items.id	number	Optional	Numeric identifier for an existing list item if applicable.
items.name	string	Optional	Value or name text stored for this list entry.
items.comment	string	Optional	Optional per-item comment for administrators.

Input Example

{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"},"name":"Example Name","type":"string","comment":"string","items":[{"id":123,"name":"Example Name","comment":"string"}]}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

{}

Create Policy List

Create a new empty custom policy list for the customer account in Symantec Cloud Secure Web Gateway. Requires JSON body with name and type.

Endpoint

URL: policy/lists

Method: POST

Input

Argument Name	Type	Required	Description
name	string	Optional	Display name for the new custom policy list.
type	string	Optional	Policy list type identifier from available list types.
comment	string	Optional	Optional administrator comment describing list purpose.

Input Example

{"name":"Example Name","type":"string","comment":"string"}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase
name	string	Name of the resource
id	string	Unique identifier
type	string	Type of the resource

Output Example

{"name":"Example Name","id":"12345678-1234-1234-1234-123456789abc","type":"string"}

Delete Policy List

Delete an unreferenced published custom list for the customer in Symantec Cloud Secure Web Gateway using the specified ID.

Endpoint

URL: policy/lists/{{id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Unique identifier of the custom policy list to delete.

Input Example

{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

{}

Get Policy List by ID

Retrieve a custom policy list and all its items from Symantec Cloud Secure Web Gateway using the specified ID as a path parameter.

Endpoint

URL: policy/lists/{{id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Unique identifier of the custom policy list to retrieve.

Input Example

{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase
name	string	Name of the policy list.
type	string	Type of the policy list.
comment	string	Optional comment for the policy list.
items	array	List of items contained in the policy list.
items.id	number	Unique identifier for the item.
items.name	string	Name of the item.
items.comment	string	Optional comment for the item.

Output Example

{"name":"Example Name","type":"string","comment":"string","items":[{"id":123,"name":"Example Name","comment":"string"}]}

Get Policy List Types

Retrieve custom policy list types that can be created or modified in Symantec Cloud Secure Web Gateway.

Endpoint

URL: policy/listTypes

Method: GET

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

[]

Get Policy Lists

Retrieve customer policy lists from Symantec Cloud Secure Web Gateway, optionally filtered by list type.

Endpoint

URL: policy/lists

Method: GET

Input

Argument Name	Type	Required	Description
parameters.type	string	Optional	When set, returns only lists matching this policy list type.

Input Example

{"parameters":{"type":"string"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

[]

Get Policy Object Items by Type

Retrieve paged policy objects by type for custom lists, sorted by name. Requires 'type' as a path parameter.

Endpoint

URL: policy/items/{{type}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.type	string	Required	Policy object type key identifying which catalog to retrieve.
parameters.page	number	Optional	Zero-based page index for paged policy object results.
parameters.size	number	Optional	Maximum number of objects returned per page request.

Input Example

{"path_parameters":{"type":"string"},"parameters":{"page":123,"size":20}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

[]

Publish Policy

Publish the customer policy in Symantec Cloud Secure Web Gateway with a default API limit of one call per fifteen minutes.

Endpoint

URL: policy/publish

Method: PUT

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

{}

Replace Policy List Items

Replace the entire contents of an existing published customer policy list in Symantec Cloud Secure Web Gateway. Requires the 'id' as a path parameter.

Endpoint

URL: policy/lists/{{id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.id	string	Required	Unique identifier of the custom policy list to replace.
name	string	Optional	List display name as stored in policy management.
type	string	Optional	Policy list type identifier for this list resource.
comment	string	Optional	Optional comment describing list purpose or change reason.
items	array	Optional	Complete set of list entries after replacement operation.
items.id	number	Optional	Numeric identifier for an existing list item if applicable.
items.name	string	Optional	Value or name text stored for this list entry.
items.comment	string	Optional	Optional per-item comment for administrators.

Input Example

{"path_parameters":{"id":"12345678-1234-1234-1234-123456789abc"},"name":"Example Name","type":"string","comment":"string","items":[{"id":123,"name":"Example Name","comment":"string"}]}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
headers	object	HTTP headers for the request
reason	string	Response reason phrase

Output Example

{}

Response Headers

Header	Description	Example
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT