Skip to content

Firewall Management API

Manage firewalls, check their status, and manage groups of firewalls.

See the guide for a narrative walkthrough of this API.

Base URL

https://api-{dataRegion}.central.sophos.com/firewall/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, us02, 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:

  • fwcm.firewall.api.config:read
  • fwcm.firewall.api.config:write
  • fwcm.firewall.group:read
  • fwcm.firewall.group:write

Operations

Firewall Config

  • Retrieve mdr-threat
    GET /firewall-config/firewalls/{firewallId}/mdr-threat-feed
  • Create indicators
    POST /firewall-config/firewalls/{firewallId}/mdr-threat-feed/indicators
  • Delete All IoCs
    DELETE /firewall-config/firewalls/{firewallId}/mdr-threat-feed/indicators
  • Delete indicators
    POST /firewall-config/firewalls/{firewallId}/mdr-threat-feed/indicators/delete
  • Search indicators
    POST /firewall-config/firewalls/{firewallId}/mdr-threat-feed/indicators/search
  • Patch mdr-threat
    PATCH /firewall-config/firewalls/{firewallId}/mdr-threat-feed/settings
  • Retrieve transaction
    GET /firewall-config/firewalls/{firewallId}/transactions/{transactionId}

Firewall Config Import Export

Firewall Groups

Firewalls

Download