Netsweeper
App Vendor: Netsweeper
App Category: IT Services
Connector Version: 1.1.0
API Version: v1
About App
Netsweeper delivers AI-driven content web filtering and threat management solutions to the telecom, enterprise, and education markets to protect users from harmful online content.
The Netsweeper app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Add Bulk Entries to a List | This action adds multiple URLs and keywords to an existing list. |
Add Entry to a List | This action adds an entry to an existing list. |
Add Entry to a List Manager | This action adds a new entry to a specific list. |
Add List to a List Manager | This action works the same as the add entry to a list manager action but enables you to use a separator to add multiple entries. |
Add List | This action adds a new list. |
Count Accounts in List Manager | This action counts the accounts that manage the list. |
Delete All Entries in List Manager | This action deletes all entries from a list. |
Delete Bulk Entries in a List | This action deletes multiple URLs and keyword IDs from all lists. |
Delete Entry in List Manager | This deletes an entry from a specific list. |
Delete List | This action deletes a list. |
Edit List | This action edits a list. |
Listing a List | This action retrieves the local and shared lists. |
Listing the List Count | This action counts the number of local, shared and all lists. |
Query List Manager | This action performs a Query if an entry exists in a list. |
Trace URL | This action traces an URL. |
Configuration Parameters
The following configuration parameters are required for the Netsweeper app to communicate with the Netsweeper enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
WSDL URL | Enter the web services description language (WSDL) URL to connect with Netsweeper. | Text | Required |
|
Username | Enter the username to authenticate with Netsweeper. | Text | Required |
|
Password | Enter the password to authenticate with Netsweeper. | Password | Required |
|
Action: Add Bulk Entries to a List
This action adds multiple URLs and keywords to an existing list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List Name | Enter the name of the list to add the entry to the List. Example: test list | Text | Optional |
|
Item | Enter the value of the item to add to the list. Example: www.google.com | Text | Optional |
|
Type | Enter the type of list to display. | Text | Optional | Allowed values:
|
Action | Enter the action to take on the item. Example: A | Text | Optional | Allowed values:
|
Args | Enter the arguments for the item. | Text | Optional | This is based on the Action used. Multiple args can be designated using a separator. |
Comment | Enter the comments for the item. Example: This is a test comment | Text | Optional | Multiple comments can be designated using a separator. |
Match case | Enter the match case for the item. Example: 1 | Boolean | Optional | Allowed values:
|
Part | Enter the part for the item. Example: S | Text | Optional | Multiple parts can be designated using a separator. Allowed values:
|
Locked | Enter the locked status for the item. Example: 1 | Boolean | Optional | Default value: 0 Allowed values:
|
Separator | Enter the separator to be used in the arguments | Text | Optional | By default, a space is used. |
Verbose | Set to 1 or true, it will return the result in verbose format. | Boolean | Optional | Allowed values:
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Callback | Enter the callback argument for the API response. | Text | Optional | This can only be used when requesting this API via AJAX request. |
Action: Add Entry to a List
This action adds an entry to an existing list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List Name | Enter the name of the list. Example: Phishing Details | Text | Required |
|
Item | Enter the value of the item to add to the list. Example: www.sampleurl.com | Text | Required |
|
Type | Enter the type of item to add to the list. | Text | Required | Allowed values:
|
Action | Enter the action to take on the item. | Text | Required | Allowed values:
|
Args | Enter the arguments for the item. | Text | Optional |
|
Comments | Enter the comments for the item. Example: Adding new entries related to the phishing incident | Text | Optional |
|
Match Case | Enter the match case for the item. | Text | Optional | Allowed values:
|
Part | Enter the part for the item. | Text | Optional | Allowed values:
|
Locked | Enter the locked status for the item. | Boolean | Optional | Default value: 0 Allowed values:
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Action: Add List to a List Manager
This action works the same as the add entry to a list manager action but enables you to use a separator to add multiple entries.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List Name | Enter the name of the list to add the entry. | Text | Required | Allowed values:
|
Type | Enter the type of list to display. | Text | Required | Allowed values:
|
Entry | Enter the multiple URLs with a separator. | Text | Required |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Action: Add List
This action adds a new list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the list to add. Example: Phishing | Text | Required |
|
Comment | Enter the comment for the list. Example: New list for the recent phishing incident | Text | Optional |
|
Restrictions | Enter the restrictions for the list. | Text | Optional | Allowed values:
|
Maximum Log Size | Enter the number of entries in the list history. | Text | Optional | Default value: 0 |
Maximum Log Age | Enter the number of days for which a list is stored in a database. | Text | Optional | Default value: 0 |
Categories | Enter the categories for the list. | Text | Optional |
|
Owner | Enter the account owner for the list. | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Action: Count Accounts in List Manager
This action counts the accounts that manage the list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List Name | Enter the name of the list to be searched for counting the accounts. Example: testlist | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Callback | Enter the callback argument for the API response. | Text | Optional | This can only be used when requesting this API via AJAX request. |
Action: Delete All Entries in List Manager
This action deletes all entries from a list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List Name | Enter the name of the list from which the entries must be deleted. Example: testlist | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Action: Delete Bulk Entries in a List
This action deletes multiple URL and keyword IDs from all lists.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
ID | Enter the ID of the entries to be deleted in a list. | Text | Optional |
|
List Name | Enter the name of the list to be deleted. Example: testlist | Text | Optional |
|
Item | Enter the value of the item to be deleted. Example: www.google.com | Text | Optional |
|
Type | Enter the type of list to display. | Text | Optional | Allowed values:
|
Action | Enter the action to take on the item. | Text | Optional | Allowed values:
|
Args | Enter the arguments for the item | Text | Optional |
|
Comment | Enter the comments for the item. Example: this is a test comment. | Text | Optional |
|
Part | Enter the part for the item. | Text | Optional | Allowed values:
|
Separator | Enter the separator to be used in the arguments | Text | Optional |
|
Verbose | If set to 1 or true, will return the result in verbose format. | Text | Optional | Allowed values:
|
Format | Enter the format for the list. | Text | Optional | Default: text Allowed values:
|
Callback | Enter the callback argument for the API response. | Text | Optional | This can only be used when requesting this API via AJAX request |
Action: Delete Entry in List Manager
This action deletes an entry from a specific list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List name | Enter the name of the list to add the entry. | Text | Optional | Allowed values:
|
Type | Enter the type of list to display. | Text | Optional | Allowed values:
|
Entry | Entry the entry to be added to the list. | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default: text Allowed values:
|
Action: Delete List
This action deletes a list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the list to delete. Example: Phishing | Text | Required |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Action: Edit List
This action edits a list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Name | Enter the name of the list to edit. Example: Phishing | Text | Required |
|
New Name | Enter the new name for the list. Example: Phishing Incident | Text | Optional |
|
Comment | Enter the comment for the list. Example: Editing a list to incorporate more details. | Text | Optional |
|
Restrictions | Enter the restrictions for the list. | Text | Optional | Allowed values:
|
Maximum Log Size | Enter the number of entries in the list history. | Text | Optional | Default value: 0 |
Maximum Log Age | Enter the number of days for which a list is stored in a database. | Text | Optional | Default value: 0 |
Categories | Enter the categories for the list. | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: xml Allowed values:
|
Action: Listing a List
This action displays the local and shared lists.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Type | Enter the type of list to display. | Text | Optional | Allowed values:
|
Detailed | Enter the detailed status for the list. | Text | Optional | Default value: false Allowed values:
|
Search | Enter the string to search and retrieve the related results. | Text | Optional |
|
Page | Enter the page number to retrieve results from a specific page. Example: 4 | Text | Optional |
|
Per page | Enter the number of items to display per page. Example: 10 | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: xml Allowed values:
|
Action: Listing the List Count
This action counts the number of local, shared, and all lists.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Type | Enter the type of list to count. | Text | Optional | Allowed values:
|
Search | Enter the search string for the list. | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: xml Allowed values:
|
Action: Query List Manager
This action performs a Query if an entry exists in a list.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
List name | Enter the name of the list to query. Example: testlist | Text | Optional |
|
Type | Enter the type of list to display. | Text | Optional | Allowed values:
|
Entry | Enter the entry to be searched for in the list. | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
Action: Trace URL
This action traces an URL.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
URL | Enter the URL to be traced. Example: https://google.com | Text | Required |
|
Client IP | Enter the client IP associated with the URL. Example: 127.0.0.1 | Text | Optional |
|
Client Name | Enter the client name associated with the URL. | Text | Optional |
|
Group Name | Enter the group name associated with the URL. | Text | Optional |
|
Policy name | Enter the policy name associated with the URL. | Text | Optional |
|
Destination ip | Enter the destination IP associated with the URL. Example: 167.0.8.1 | Text | Optional |
|
User agent | Enter the user agent associated with the URL. | Text | Optional |
|
Referrer | Enter the referrer associated with the URL. | Text | Optional |
|
Raw | This displays the raw output of the remote admin command | Text | Optional |
|
Format | Enter the format for the list. | Text | Optional | Default value: text Allowed values:
|
All steps | This shows all policy processing steps for a request until processing stops | Text | Optional |
|