Overview

The Umbrella Secure Web Gateway (SWG) Device Settings API enables you to manage the SWG override setting on devices. The Umbrella Secure Web Gateway Device Settings API follows RESTful principles and uses JSON for requests and responses.

Use Cases

  • List the Umbrella roaming computer data for the organization and write to a CSV file
  • Import the organization's Umbrella roaming computer data from a CSV file
  • Set the SWG override setting on the devices
  • List the SWG override setting on the devices
  • Remove the SWG override setting on the devices

Prerequisites

  • A valid Umbrella API key configured with access to the deployments.roamingcomputers:read, deployments.devices.swg:read, and deployments.devices.swg:write scopes. For more information, see Umbrella Authentication.
  • Python 3.x

Secure Web Gateway Device Settings API Endpoints

  • POST /deployments/v2/deviceSettings/SWGEnabled/set
  • POST /deployments/v2/deviceSettings/SWGEnabled/list
  • POST /deployments/v2/deviceSettings/SWGEnabled/remove

Roaming Computers API Endpoints

  • GET /deployments/v2/roamingcomputers

Environment Variables

The sample scripts require that you set up various environment variables:

  • API_KEY—Umbrella API key.
  • API_SECRET—Umbrella API secret.
  • CISCO_SAMPLE_DIR—The directory where to place the scripts, and the location of the subdirectories that contain the exported roaming computer information.
  • RC_FILENAME—Path to local CSV file that contains Umbrella roaming computer information.

Troubleshooting

  • When you copy a script from the docs, check that the sample does not contain an HTML entity, for example: (>). Replace the HTML greater than (>) sign with the greater than (>) symbol.

What's Next