modules

A majority of the calls in this section of the API are deprecated. Sometime in the future the modules will provide their own API that will hook into the appliance API. Most of the calls here will be migrated and mainted by the module teams.

Deprecated since version 1.0.

Details

Resource

Operation

Description

Module

GET /api/app/v1/(module)/debugging

Debug control

PUT /api/app/v1/(module)/debugging

PUT /api/app/v1/disk/(mount_type)/(module)

Mount a filestore into module

Module-ESG

GET /api/app/v1/esg/dig

Run dig command

GET /api/app/v1/esg/email_shell

Email shell

PUT /api/app/v1/esg/email_subscription_reset

Reset email subscription

GET /api/app/v1/esg/maillog

Show/Download maillog

GET /api/app/v1/esg/pem

Download PEM backup to filestore

Module-WCG

GET /api/app/v1/wcg/content_line

Execute WCG content_line

PUT /api/app/v1/wcg/content_line

GET /api/app/v1/wcg/dpm_status

Get DPM status

GET /api/app/v1/wcg/policy_engine

Policy Engine control

PUT /api/app/v1/wcg/policy_engine

GET /api/app/v1/wcg/print_bypass

Get WCG bypass list

GET /api/app/v1/wcg/proxy_net_check

Proxy Net Check

PUT /api/app/v1/wcg/pwd_reset

Reset WCG password.

Module-WSE

GET /api/app/v1/wse/cache_user_names

Enable/disable caching of WISP users

PUT /api/app/v1/wse/cache_user_names

PUT /api/app/v1/wse/do/(service)

Enable/disable WSE services

GET /api/app/v1/wse/policy_broker_token

Retrieve Policy Broker token

GET /api/app/v1/wse/user_group_ip_precedence

Enable/disable user group ip precedence

PUT /api/app/v1/wse/user_group_ip_precedence

Summary

GET /api/app/v1/(module)/debugging

Resets debug to default or gets the status.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the modules

Parameters:

  • module (required) – Module to execute the command on

Query Parameters:

  • command (optional) – Either status or reset

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Get debugging status on WCG:

GET /api/app/v1/wcg/debugging?command=status HTTP/1.1
Accept: text/html

Example 1 - Response: Get debugging status on WCG:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "Debug log is disabled"
}

Example 2 - Request: Reset debugging on WCG:

PUT /api/app/v1/wcg/policy_engine?command=reset HTTP/1.1
Accept: text/html

Example 2 - Response: Reset debugging on WCG:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
PUT /api/app/v1/(module)/debugging

Resets debug to default or gets the status.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the modules

Parameters:

  • module (required) – Module to execute the command on

Query Parameters:

  • command (optional) – Either status or reset

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Get debugging status on WCG:

GET /api/app/v1/wcg/debugging?command=status HTTP/1.1
Accept: text/html

Example 1 - Response: Get debugging status on WCG:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "Debug log is disabled"
}

Example 2 - Request: Reset debugging on WCG:

PUT /api/app/v1/wcg/policy_engine?command=reset HTTP/1.1
Accept: text/html

Example 2 - Response: Reset debugging on WCG:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
PUT /api/app/v1/disk/(mount_type)/(module)

Mount a filestore into a module.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the modules

Warning

If your Samba server does not support v1 the vers parameter is required. Otherwise the mount will fail.

Parameters:

  • mount_type (requred) – Mount action (mount, unmount)

  • module (required) – Module to mount into

Query Parameters:

  • type (required) – Type of mount (samba, nfs)

  • path (required) – Path within the module to mount to

  • location (required) – Location of the network drive to mount

  • user (optional) – username for Samba

  • passwd (optional) – password for Samba user

  • vers (optional) – version for Samba (required for any version of Samba higher that 1.0)

  • sec (optional) – security mode

Response Headers:
Status Codes:

Example 1 - Request: Samba mount:

PUT /api/app/v1/disk/mount/wcg?type=samba&path=/mnt&location=//10.206.6.76/anonymous&user=guest&passwd=guest HTTP/1.1
Accept: text/html

Example 1 - Response: Samba mount:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}

Example 2 - Request: NFS Mount:

PUT /api/app/v1/disk/mount/wcg?type=nfs&path=/mnt&location=10.206.4.100:/data/ISOs HTTP/1.1
Accept: text/html

Example 2 - Response: NFS Mount:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}

Example 3 - Request: Unmount:

PUT /api/app/v1/disk/umount/wcg?path=/mnt HTTP/1.1
Accept: text/html

Example 3 - Response: Unmount:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
GET /api/app/v1/esg/dig

Runs DIG.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the ESG container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • x (optional) – PTR lookup. Takes IP address

  • txt (optional) – TXT lookup

  • mx (optional) – MX lookup

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Dig using PTR lookup:

GET /api/app/v1/esg/dig?x=10.206.4.166 HTTP/1.1
Accept: text/html

Example 1 - Response: Dig using PTR lookup:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "<DIG_OUTPUT>"
}
GET /api/app/v1/esg/email_shell

Sends email-shell debug module to ESG

Accepted Authorization:

admin

PUT /api/app/v1/esg/email_subscription_reset

Reset email subscription.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the ESG container

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Reset email subscription:

GET /api/app/v1/esg/email_subscription_reset HTTP/1.1
Accept: application/json

Example 1 - Response: Reset email subscription:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "Success"
}
GET /api/app/v1/esg/maillog

Show or Download ESG maillog.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the ESG container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • command (required) – Command to execute (show, download)

  • alias (optional) – Filestore to download to

  • file (optional) – Name of the file to download to the filestore

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Show maillog:

GET /api/app/v1/esg/maillog?command=show HTTP/1.1
Accept: application/json

Example 1 - Response: Show maillog:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "<MAILLOG_INFO>"
}

Example 2 - Request: Download maillog to filestore:

GET /api/app/v1/esg/maillog?command=download\&alias=myfilestore\&file=maillog.5.gz HTTP/1.1
Accept: application/json

Example 2 - Response: Download maillog to filestore:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
GET /api/app/v1/esg/pem

Download PEM backup to filestore.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the ESG container

Query Parameters:

  • alias (required) – Filestore to download to

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Download PEM data to filestore:

GET /api/app/v1/esg/pem?alias=myfilestore HTTP/1.1
Accept: application/json

Example 1 - Response: Download PEM data to filestore:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
GET /api/app/v1/wcg/content_line

Runs WCG’s content_line to configure variables.

Deprecated since version 1.0.

Note

The parameters match the usage of the command line content_line

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • r (required) – Read variable

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Read a variable:

GET /api/app/v1/wcg/content_line?r=proxy.config.diags.debug.enabled HTTP/1.1
Accept: text/html

Example 1 - Response: Read a variable:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "0"
}
PUT /api/app/v1/wcg/content_line

Runs WCG’s content_line to configure variables.

Deprecated since version 1.0.

Note

The paramaters match the useage of the command line content_line

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe

Query Parameters:

  • s (optional) – Set variable (requires v option)

  • v (optional) – Set value (used with s option)

  • x (optional) – Reread config files (set to on to use)

  • y (optional) – Clear dynamic cert (set to on to use)

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Reread config file:

PUT /api/app/v1/wcg/content_line?x=on HTTP/1.1
Accept: text/html

Example 1 - Response: Reread config file:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
GET /api/app/v1/wcg/dpm_status

Get Decrypt Port Mirror status.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Get DPM status:

PUT /api/app/v1/wcg/dpm_status HTTP/1.1
Accept: text/html

Example 1 - Response: Get DPM status:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "dpm": {
    "proxy.config.ssl_decryption.custom_request_header": "",
    "proxy.config.ssl_decryption.mirror_enabled": 0,
    "proxy.config.ssl_decryption.mirror_interface": "NULL"
  }
}
GET /api/app/v1/wcg/policy_engine

Performs the following for WCG’s policy engine (status)

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Query Parameters:

  • status (optional) – Policy Engine status

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Get Policy Engine status:

GET /api/app/v1/wcg/policy_engine?command=status HTTP/1.1
Accept: text/html

Example 1 - Response: Get Policy Engine status:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "pewd (pid  660) is running..."
}
PUT /api/app/v1/wcg/policy_engine

Performs the following for WCG’s policy engine (start, stop, restart)

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Query Parameters:

  • start (optional) – Start Policy Engine

  • stop (optional) – Stop Policy Engine

  • restart (optional) – Restart Policy Engine

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Restart Policy Engine:

PUT /api/app/v1/wcg/policy_engine?command=restart HTTP/1.1
Accept: text/html

Example 1 - Response: Restart Policy Engine:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
GET /api/app/v1/wcg/print_bypass

Prints WCG bypass list. This is a set of websites that bypass the Content Gateway processing.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:

Example 1 - Request: Get bypass list:

GET /api/app/v1/wcg/print_bypass HTTP/1.1
Accept: text/html

Example 1 - Response: Get bypass list:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "# Reading the bypass entries ... # There are 0 entries in the source bypass table # There are 0 entries in the destination bypass table # There are 0 entries in the and bypass table"
}
GET /api/app/v1/wcg/proxy_net_check

Proxy Net Check

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WCG container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Check Proxy Network:

GET/api/app/v1/wcg/proxy_net_check HTTP/1.1
Accept: text/html

Example 1 - Response: Check Proxy Network:

Responses vary

PUT /api/app/v1/wcg/pwd_reset

Resets the Web Content Gateway user password and provides the temporary password.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Reset WCG user password:

PUT /api/app/v1/wcg/pwd_reset HTTP/1.1
Accept: application/json

Example 1 - Response: Reset WCG user password:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "password": "<TEMP_PASSWORD>"
}
GET /api/app/v1/wse/cache_user_names

Get current WISTP configuration settings.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • command (required) – Command to execute (status)

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Get status:

GET /api/app/v1/wse/cache_user_names?command=status HTTP/1.1
Accept: application/json

Example 1 - Response: Get status:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "CacheWISPUsers=off"
}
PUT /api/app/v1/wse/cache_user_names

Enable/disable caching of WISP users.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe

resheader Content-Type:

application/json

status 200:

Success

status 401:

Access Denied

Accepted Authorization:

admin

Example 1 - Request: Enable caching:

PUT /api/app/v1/wse/cache_user_names?command=enable HTTP/1.1
Accept: application/json

Example 1 - Response: Enable caching:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}
PUT /api/app/v1/wse/do/(service)

Enable/disable WSE services. This currently only supports State Server or Directory Agent.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • command (required) – Command to execute (enable, disable)

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin

Example 1 - Request: Disable State Server:

PUT /api/app/v1/wse/do/state_server?command=disable HTTP/1.1
Accept: application/json

Example 1 - Response: Disable State Server:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "Stopping Websense State Server ... Waiting for Websense State Server to terminate... Websense State Server stopped successfully."
}

Example 2 - Request: Enable Directory Agent:

PUT /api/app/v1/wse/do/directory_agent?command=enable HTTP/1.1
Accept: application/json

Example 2 - Response: Enable Directory Agent:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "Starting Websense Directory Agent... Websense Directory Agent started successfully."
}
GET /api/app/v1/wse/policy_broker_token

Retrieves Policy Broker token.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Retrieve Policy Broker token:

GET /api/app/v1/wse/policy_broker_token HTTP/1.1
Accept: application/json

Example 1 - Response: Reset Policy Broker token:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "<POLICY_BROKER_TOKEN>"
}
GET /api/app/v1/wse/user_group_ip_precedence

Get current User Group IP Precedence configuration setting.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe unless scrub_output parameter is used.

Query Parameters:

  • command (required) – Command to execute (status)

  • scrub_output (optional) – If output should be stripped of unescaped characters, True or False. Default: False, output will contain new line characters, etc.

Response Headers:
Status Codes:
Accepted Authorization:

admin, audit

Example 1 - Request: Get status:

GET /api/app/v1/wse/user_group_ip_precedence?command=status HTTP/1.1
Accept: application/json

Example 1 - Response: Get status:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "output": "UserGroupIpPrecedence=false"
}
PUT /api/app/v1/wse/user_group_ip_precedence

Enable/disable User Group IP Precedence in AD or get current configuration setting.

Deprecated since version 1.0.

Warning

This command is deprecated and will eventually be replaced with an API call provided by the WSE container

Warning

This command returns unescaped characters such as Unix new line character and octothorpe

resheader Content-Type:

application/json

status 200:

Success

status 401:

Access Denied

Accepted Authorization:

admin

Example 1 - Request: Enable User Group Precedence:

PUT /api/app/v1/wse/user_group_ip_precedence?command=enable HTTP/1.1
Accept: application/json

Example 1 - Response: Enable User Group Precedence:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Status": "Success"
}