Skip to content

Account Health Check API

Run an account health check across a tenant's endpoint estate.

See the guide for a narrative walkthrough of this API.

Base URL

https://api-{dataRegion}.central.sophos.com/account-health-check/v1 — Data region.

Variable Description Default Allowed values
dataRegion 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:

  • endpoint-policy:update OR endpoint-state:update OR endpoint-server:update OR endpoint-computer:update OR firewall-state:update
  • endpoint-state:read OR firewall-state:read

Operations

Account Health Check

Account Health Scores

Account Health Snooze

Download