Web Filtering API¶
Manage web filtering configuration.
Base URL¶
https://api-{dataRegion}.central.sophos.com/web-filters/v1 — Regional service in the production environment.
| Variable | Description | Default | Allowed values |
|---|---|---|---|
dataRegion | The data region where tenant data is stored. | eu01 | eu01, eu02, us01, us03, ca01, au01, jp01, in01, br01, ae01 |
Authentication¶
Every request carries an Authorization: Bearer header with an access token obtained through the client-credentials flow — see Get started.
Required permissions¶
This API's operations require one or more of the following, depending on the operation — see each operation's own page for the exact requirement:
web-profiles:readweb-profiles:write
Operations¶
Web Filter Site List Management¶
- Get site lists
GET/site-lists - Create a site list
POST/site-lists - Get site list
GET/site-lists/{siteListId} - Update site list
PUT/site-lists/{siteListId} - Delete site list
DELETE/site-lists/{siteListId} - Clone site list
POST/site-lists/{siteListId}/clone - Get Sites
GET/site-lists/{siteListId}/sites - Add Site
POST/site-lists/{siteListId}/sites - Delete Site
DELETE/site-lists/{siteListId}/sites/{siteId}
Web Filtering Profile Management¶
- Get web filtering profiles
GET/profiles - Add a web filtering profile
POST/profiles - Get profile metadata
GET/profiles/metadata - Get web filtering profile
GET/profiles/{profileId} - Update web filtering profile
PUT/profiles/{profileId} - Delete web filtering profile
DELETE/profiles/{profileId} - Clone web filtering profile
POST/profiles/{profileId}/clone
Download¶