Skip to main content

Overview API Reference Developer Portal

Introduction
Active threat response MDR
Active threat response Sophos X-Ops
Active threat response third party threat feeds
Active threat response threat exclusions
Administration access profiles
Administration API access settings
Administration messages
Administration portal settings
Administration schedules
Administration system settings
Application attributes
Application filter categories
Application filter policies
Application objects
Applications
Authentication access time profiles
Authentication admin user password
Authentication captive portal appearance
Authentication chromebook SSO settings
Authentication global user session settings
Authentication live users
Authentication login security settings
Authentication network traffic quotas
Authentication network user login and logout
Authentication password complexity settings
Authentication radius accounting SSO settings
Authentication servers
Authentication servers priority list
Authentication SMS gateway settings
Authentication STAS collectors
Authentication STAS settings
Authentication STAS VPN source networks
Authentication surfing quota policies
Authentication TOTP settings
Authentication TOTP tokens
Authentication user groups
Authentication users
Authentication web authentication settings
Certificate authorities
Certificate default CA
Certificate locally signed certificates
Certificate revocation lists
Certificate signing requests
Certificate uploaded certificates
Certificates
DoS attacks
DoS policies
DoS settings
Firewall health check
Firewall local service ACL exception rules
Firewall NAT rules
Firewall rules
IPS custom signatures
IPS policies
IPS settings
IPS signature attributes
IPsec failover groups
IPsec profiles
IPsec remote access VPN settings
IPsec site-to-site connections
IPsec site-to-site live connections
Log attributes
Log destinations
Log destinations syslog servers
Log settings
Malware protection
Monitoring NetFlow configuration
Monitoring SNMP agent configuration
Monitoring SNMP communities
Monitoring SNMP users
Network address groups country
Network address groups FQDN
Network address groups IPv4
Network address groups IPv6
Network addresses FQDN
Network addresses IPv4
Network addresses IPv6
Network addresses MAC
Network cellular WAN
Network DHCP relays
Network DHCP server settings
Network DHCPv4 servers
Network DHCPv6 servers
Network DNS host entries
Network DNS request routes
Network DNS settings
Network interfaces
Network mDNS configuration
Network neighbor configuration
Network neighbors
Network router advertisements
Network service groups
Network services
Network zones
Notification list
Routing gateways
Routing multicast routes
Routing multicast settings
Routing unicast routes
SD-WAN routes
Sophos Central
Spoof protection general settings
Spoof protection trusted MACs
SSL VPN bookmark groups
SSL VPN bookmarks
SSL VPN clientless policies
SSL VPN global settings
SSL VPN remote access policies
SSL/TLS inspection decryption profiles
SSL/TLS inspection rules
SSL/TLS inspection settings
Support access
System automatic pattern updates
System backup settings
System hotfix settings
System security updates
Traffic shaping policies
Traffic shaping settings
WAF authentication policies
WAF authentication templates
WAF protection policies
WAF web servers
Web filter categories
Web filter content condition lists
Web filter exceptions
Web filter policies
Web filter protection settings
Web filter URL groups
Web filter user activities
Web filter user notification settings
Wireless hotspot settings
Wireless hotspot vouchers
Wireless hotspots
Zero-day protection
Schemas

IPsec failover groups
Update failovergroup

Update failovergroup

PATCH /ipsec-vpn/site-to-site/failover-groups/:idOrName

Update failovergroup.

Request

Responses

200
400
401
403
404
500

Updated failovergroup.

Invalid request.

Authentication required.

Authorization required.

Failovergroup not found.

Internal server error.

Get IPsec failovergroup

Delete failovergroup

Reference

Overview & Getting Started
API Reference

Sophos

Developer Portal
Support
Sophos.com

Open Source

Built with Docusaurus
Licenses

© 2026 Sophos Ltd. All rights reserved.