Sophos Central
App · 24 actions
Work with Sophos Central (Sophos Intercept X) endpoint and server security: triage and act on alerts, isolate, release and scan endpoints, manage Tamper Protection, endpoint groups and blocked files, read events and the account health check, and start workflows on new alerts, events and endpoints, unhealthy, isolated or offline endpoints and Tamper Protection turned off.
Actions
| Action | What it does |
|---|---|
| Act on alert | Acknowledge an alert, clean up or clear its threat, clean up or authorize a PUA, or message the user. |
| Add endpoints to group | Move endpoints into a group, taking them out of any group they were in. |
| Block file | Block a file from running on every endpoint, by its SHA-256 hash, such as one from an alert or event. |
| Check endpoint for updates | Ask an endpoint to check for Sophos updates now rather than at its next scheduled check. |
| Create endpoint group | Make a group of computers or servers, with endpoints in it if you choose them. |
| Delete endpoint group | Delete an endpoint group. |
| Get account health check | Get Sophos Central's account health check: scores from 0 to 100 for protection installed, policies, risky exclusions and Tamper Protection, and how many endpoints fall short. |
| Get alert | Get one alert: what happened, its severity and category, the device and person, and the actions it allows. |
| Get endpoint | Get one endpoint: its health, operating system, addresses, group, person, isolation, Tamper Protection and installed Sophos products. |
| Get endpoint isolation | Whether an endpoint is set to be isolated, with who last isolated or released it, when and why. |
| Get Tamper Protection | Whether Tamper Protection is on for an endpoint, with its current password (to change Sophos settings or uninstall on the endpoint) and old passwords. |
| Get user | Get one person from the directory, such as the person on an endpoint or in an alert. |
| Isolate endpoints | Cut endpoints off the network so a threat can't spread. |
| List alerts | Find Sophos Central alerts, newest first, by severity, category, product or time, with the device and person each is about and what can be done about it. |
| List blocked items | List the files blocked from running on every endpoint, with why and who blocked each. |
| List endpoint groups | List the groups endpoints are organised in, by name, with how many endpoints each holds. |
| List endpoints | Find computers and servers protected by Sophos, by health, type, isolation, online state, Tamper Protection, group, hostname, person, IP address or when last seen. |
| List events | Read Sophos Central's event log from the last 24 hours, oldest first: threats found and cleaned, endpoints registered, updates failing, web sites blocked and more. |
| List users | List the people in Sophos Central's directory, by name, with their email and groups. |
| Release endpoints from isolation | Put isolated endpoints back on the network. |
| Remove endpoints from group | Take endpoints out of a group. |
| Scan endpoints | Start a scan on each endpoint. |
| Unblock file | Remove a blocked item, so the file may run again. |
| Update Tamper Protection | Turn Tamper Protection on or off for an endpoint, make a new password for it, or both. |
Act on alert
Acknowledge an alert, clean up or clear its threat, clean up or authorize a PUA, or message the user. Only the actions in the alert's allowed_actions work.
Inputs
- Alert ID
alert_idtextRequired - The alert's id, from 'List alerts', a trigger or an earlier step.
- Action
alert_actiontextRequired - What to do. Acknowledge resolves the alert; the others act on what it found.One of:
acknowledge(Acknowledge (mark it resolved)),clearThreat(Mark the threat as cleaned up),cleanVirus(Clean up the threat),cleanPua(Clean up the PUA),authPua(Authorize the PUA (let it run)),clearHmpa(Clear the exploit detection),sendMsgThreat(Send the user a message about the threat),sendMsgPua(Send the user a message about the PUA). - Message
messagetext - A message to go with the action, such as the text the user sees.
Outputs
actiontext- The action sent
alert_idtext- The alert
completed_attext- When it completed
idtext- The action's id
requested_attext- When it was requested
resulttext- How it went, once completed
started_attext- When it started
statustext- requested, started or completed
Example output
{
"action": "acknowledge",
"alert_id": "0f1e2d3c-4b5a-4968-8776-a5b4c3d2e1f0",
"completed_at": "2026-11-10T14:30:00.400Z",
"id": "3b2a1c0d-9e8f-4a7b-b6c5-d4e3f2a1b0c9",
"requested_at": "2026-11-10T14:30:00.000Z",
"result": "success",
"started_at": "2026-11-10T14:30:00.100Z",
"status": "completed"
}Add endpoints to group
Move endpoints into a group, taking them out of any group they were in.
Inputs
- Endpoint group
group_idtextRequired - The group, chosen by name, or its id from 'List endpoint groups'.
- Endpoints
endpoint_idslistRequired - The endpoints to add, of the group's type (computers or servers).
Outputs
addedlist- The endpoints added
added_countnumber- How many were added
group_idtext- The group
not_foundlist- Ids Sophos couldn't find
wrong_typelist- Endpoints not added because they're the wrong type
Example output
{
"added": [
{
"hostname": "DESKTOP-F82003",
"id": "4f725e46-a174-45a7-a352-49ed15840ab1"
}
],
"added_count": 1,
"group_id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"not_found": [],
"wrong_type": []
}Block file
Block a file from running on every endpoint, by its SHA-256 hash, such as one from an alert or event.
Inputs
- SHA-256 hash
sha256textRequired - The file's SHA-256 hash: 64 letters and digits.
- Reason
commenttextRequired - Why it is blocked, shown in Sophos Central.
- File name
file_nametext - The file's name, to show beside the hash.
Outputs
idtext- The blocked item's id
itemobject- The blocked item
Example output
{
"id": "6e5d4c3b-2a19-4087-b6a5-948372615f4e",
"item": {
"certificate_signer": "",
"comment": "Blocked after the phishing campaign",
"created_at": "2026-11-10T14:40:00.000Z",
"created_by": "Lodol automation",
"file_name": "invoice.exe",
"id": "6e5d4c3b-2a19-4087-b6a5-948372615f4e",
"origin_endpoint_id": "",
"origin_person": "",
"path": "",
"sha256": "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f",
"type": "sha256",
"updated_at": "2026-11-10T14:40:00.000Z"
}
}Check endpoint for updates
Ask an endpoint to check for Sophos updates now rather than at its next scheduled check.
Inputs
- Endpoint
endpoint_idtextRequired - The endpoint, chosen by name, or its id from 'List endpoints', an alert's endpoint_id or a trigger.
Outputs
endpoint_idtext- The endpoint
requested_attext- When it was requested
statustext- requested
Example output
{
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"requested_at": "2026-11-10T14:36:00.000Z",
"status": "requested"
}Create endpoint group
Make a group of computers or servers, with endpoints in it if you choose them.
Inputs
- Name
nametextRequired - The group's name.
- Group type
group_typetextRequired - Whether the group holds computers or servers.One of:
computer,server. - Description
descriptiontext - What the group is for.
- Endpoints
endpoint_idslist - Endpoints to put in it. An endpoint can be in one group at a time.
Outputs
groupobject- The new group
idtext- The new group's id
Example output
{
"group": {
"created_at": "2026-01-15T09:00:00.000Z",
"description": "Laptops used by the finance team",
"endpoint_count": 1,
"endpoint_hostnames": [
"DESKTOP-F82003"
],
"endpoint_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"name": "Finance laptops",
"type": "computer",
"updated_at": "2026-11-01T09:00:00.000Z"
},
"id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
}Delete endpoint group
Delete an endpoint group. Its endpoints stay protected, in no group.
Inputs
- Endpoint group
group_idtextRequired - The group, chosen by name, or its id from 'List endpoint groups'.
Outputs
deletedtrue/false- True once it is deleted
group_idtext- The group
Example output
{
"deleted": true,
"group_id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d"
}Get account health check
Get Sophos Central's account health check: scores from 0 to 100 for protection installed, policies, risky exclusions and Tamper Protection, and how many endpoints fall short.
Inputs
- Checks
checkslist - Which checks to run. Leave empty for all.One or more of:
protection(Protection installed),policy(Policies on recommended settings),exclusions(Risky exclusions),tamperProtection(Tamper Protection).
Outputs
computer_policies_not_recommendednumber- Computer policies with a setting off its recommended value
computer_policy_scorenumber- Computer threat protection policies, scored 0 to 100
computers_not_fully_protectednumber- Computers missing protection software
computers_protection_scorenumber- Computers with protection installed, scored 0 to 100
computers_tamper_protection_offnumber- Computers with Tamper Protection off
computers_tamper_protection_scorenumber- Computers with Tamper Protection on, scored 0 to 100
computers_totalnumber- How many computers
detailsobject- The full endpoint health check, as Sophos gives it
global_exclusions_scorenumber- Global exclusions, scored 0 to 100
risky_global_exclusionsnumber- Global exclusions that may be a security risk
server_policies_not_recommendednumber- Server policies with a setting off its recommended value
server_policy_scorenumber- Server threat protection policies, scored 0 to 100
servers_not_fully_protectednumber- Servers missing protection software
servers_protection_scorenumber- Servers with protection installed, scored 0 to 100
servers_tamper_protection_offnumber- Servers with Tamper Protection off
servers_tamper_protection_scorenumber- Servers with Tamper Protection on, scored 0 to 100
servers_totalnumber- How many servers
tamper_protection_on_globallytrue/false- True if Tamper Protection is on for the whole tenant
tenant_idtext- The tenant's id
tenant_nametext- The tenant's name
Example output
{
"computer_policies_not_recommended": 1,
"computer_policy_score": 90,
"computers_not_fully_protected": 2,
"computers_protection_score": 98,
"computers_tamper_protection_off": 3,
"computers_tamper_protection_score": 97,
"computers_total": 120,
"details": {
"protection": {
"computer": {
"notFullyProtected": 2,
"score": 98,
"snoozed": false,
"total": 120
}
}
},
"global_exclusions_score": 100,
"risky_global_exclusions": 0,
"server_policies_not_recommended": 0,
"server_policy_score": 100,
"servers_not_fully_protected": 0,
"servers_protection_score": 100,
"servers_tamper_protection_off": 0,
"servers_tamper_protection_score": 100,
"servers_total": 8,
"tamper_protection_on_globally": true,
"tenant_id": "57ca9a6b-885f-4e36-95ec-290548c26059",
"tenant_name": "Acme Corp"
}Get alert
Get one alert: what happened, its severity and category, the device and person, and the actions it allows.
Inputs
- Alert ID
alert_idtextRequired - The alert's id, from 'List alerts', a trigger or an earlier step.
Outputs
alertobject- The alert
Example output
{
"alert": {
"allowed_actions": [
"acknowledge",
"cleanVirus"
],
"category": "malware",
"description": "Malware detected: 'Troj/Agent-BCDE' at 'C:\\Users\\jdoe\\Downloads\\invoice.exe'",
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"endpoint_name": "DESKTOP-F82003",
"endpoint_type": "computer",
"group_key": "MSxFdmVudDo6RW5kcG9pbnQ6OlRocmVhdDo6RGV0ZWN0ZWQs",
"id": "0f1e2d3c-4b5a-4968-8776-a5b4c3d2e1f0",
"person_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"person_name": "Jane Doe",
"product": "endpoint",
"raised_at": "2026-11-10T14:22:05.123Z",
"severity": "high",
"tenant_id": "57ca9a6b-885f-4e36-95ec-290548c26059",
"tenant_name": "Acme Corp",
"type": "Event::Endpoint::Threat::Detected"
}
}Get endpoint
Get one endpoint: its health, operating system, addresses, group, person, isolation, Tamper Protection and installed Sophos products.
Inputs
- Endpoint
endpoint_idtextRequired - The endpoint, chosen by name, or its id from 'List endpoints', an alert's endpoint_id or a trigger.
Outputs
endpointobject- The endpoint
Example output
{
"endpoint": {
"admin_isolated": false,
"assigned_products": [
{
"code": "interceptX",
"status": "installed",
"version": "2024.3.1.4"
},
{
"code": "coreAgent",
"status": "installed",
"version": "2024.3.1.2"
}
],
"cloud_instance_id": "",
"cloud_provider": "",
"encryption_status": "encrypted",
"group_id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"group_name": "Finance laptops",
"health": "good",
"hostname": "DESKTOP-F82003",
"id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"ipv4_addresses": [
"10.10.10.100"
],
"ipv6_addresses": [
"fe80::9f3e:aeff:8892:bb8"
],
"is_server": false,
"isolation_status": "notIsolated",
"last_agent_update_at": "2026-11-11T02:10:00.000Z",
"last_os_update_at": "2026-11-05T19:00:00.000Z",
"last_seen_at": "2026-11-12T09:41:00.000Z",
"lockdown_status": "",
"mac_addresses": [
"00:0B:FF:E1:C2:C2"
],
"online": true,
"os_name": "Windows 11 Pro",
"os_platform": "windows",
"os_version": "10.0.22631",
"person_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"person_login": "ACME\\jdoe",
"person_name": "Jane Doe",
"self_isolated": false,
"serial_number": "",
"services_health": "good",
"services_not_running": [],
"tags": [
"site:hq"
],
"tamper_protection_enabled": true,
"tamper_protection_supported": true,
"threats_health": "good",
"type": "computer"
}
}Get endpoint isolation
Whether an endpoint is set to be isolated, with who last isolated or released it, when and why.
Inputs
- Endpoint
endpoint_idtextRequired - The endpoint, chosen by name, or its id from 'List endpoints', an alert's endpoint_id or a trigger.
Outputs
commenttext- The reason given when it was last changed
enabledtrue/false- True if it is set to be isolated
endpoint_idtext- The endpoint
last_disabled_attext- When isolation was last turned off
last_disabled_bytext- Who last turned it off
last_enabled_attext- When isolation was last turned on
last_enabled_bytext- Who last turned it on (a name, email or client id)
Example output
{
"comment": "Cleaned up, back to work",
"enabled": false,
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"last_disabled_at": "2026-11-10T16:00:00.000Z",
"last_disabled_by": "admin@acme.example",
"last_enabled_at": "2026-11-10T14:25:00.000Z",
"last_enabled_by": "Lodol automation"
}Get Tamper Protection
Whether Tamper Protection is on for an endpoint, with its current password (to change Sophos settings or uninstall on the endpoint) and old passwords.
Inputs
- Endpoint
endpoint_idtextRequired - The endpoint, chosen by name, or its id from 'List endpoints', an alert's endpoint_id or a trigger.
Outputs
enabledtrue/false- True if Tamper Protection is on
endpoint_idtext- The endpoint
passwordtext- The current Tamper Protection password
previous_passwordslist- Old passwords
Example output
{
"enabled": true,
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"password": "8sK2pQ9vX4mT",
"previous_passwords": [
{
"invalidated_at": "2026-10-01T08:00:00.000Z",
"password": "r7Lw3nB6cJ1z"
}
]
}Get user
Get one person from the directory, such as the person on an endpoint or in an alert.
Inputs
- User
person_idtextRequired - The person, chosen by name, or their id from an endpoint's person_id or an alert's person_id.
Outputs
userobject- The user
Example output
{
"user": {
"created_at": "2025-03-02T10:15:00.000Z",
"domain": "acme.example",
"email": "jane.doe@acme.example",
"exchange_login": "jdoe",
"first_name": "Jane",
"group_ids": [
"d4c3b2a1-0f9e-4d8c-b7a6-958473625140"
],
"group_names": [
"Finance"
],
"id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"last_name": "Doe",
"manager_name": "Sam Lee",
"name": "Jane Doe",
"source_type": "activeDirectory",
"updated_at": "2026-10-01T08:00:00.000Z"
}
}Isolate endpoints
Cut endpoints off the network so a threat can't spread. They can still reach Sophos Central, so they can be cleaned up and released.
Inputs
- Endpoints
endpoint_idslistRequired - The endpoints to isolate, up to 500.
- Reason
commenttext - Why they're isolated, shown in Sophos Central (up to 400 characters).
Outputs
accepted_countnumber- How many Sophos accepted
accepted_idslist- The endpoints Sophos accepted
endpoint_idslist- The endpoints it was asked about
errorslist- The endpoints it didn't accept
Example output
{
"accepted_count": 1,
"accepted_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"endpoint_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"errors": []
}List alerts
Find Sophos Central alerts, newest first, by severity, category, product or time, with the device and person each is about and what can be done about it.
Inputs
- Severities
severitieslist - Only alerts of these severities. Leave empty for all.One or more of:
high,medium,low. - Categories
categorieslist - Only alerts in these categories. Leave empty for all.One or more of:
malware,pua(Potentially unwanted application (PUA)),runtimeDetections(Runtime detections),criticalAttackWarning(Critical attack warning),security,protection,isolation,blockListed(Blocked item),applicationControl(Application control),appReputation(Application reputation), and 30 more. - Products
productslist - Only alerts from these Sophos products. Leave empty for all.One or more of:
endpoint,server,mobile,encryption,emailGateway(Email),webGateway(Web gateway),phishThreat(Phish Threat),wireless,firewall,ztna, and 3 more. - Raised after
raised_afterdate and time - Only alerts raised at or after this time.
- Raised before
raised_beforedate and time - Only alerts raised before this time.
- Group key
group_keytext - Only alerts with this group key (an alert's group_key), to find others like it.
- Limit
limitnumber - How many to return, 1 to 100. Defaults to 50.From 1 to 100.
- Next page key
page_keytext - The 'next_page_key' from the previous page, to read on.
Outputs
alertslist- The alerts on this page, newest first
countnumber- How many are on this page
has_moretrue/false- True if another page follows
next_page_keytext- Give this as 'Next page key' to read the next page
Example output
{
"alerts": [
{
"allowed_actions": [
"acknowledge",
"cleanVirus"
],
"category": "malware",
"description": "Malware detected: 'Troj/Agent-BCDE' at 'C:\\Users\\jdoe\\Downloads\\invoice.exe'",
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"endpoint_name": "DESKTOP-F82003",
"endpoint_type": "computer",
"group_key": "MSxFdmVudDo6RW5kcG9pbnQ6OlRocmVhdDo6RGV0ZWN0ZWQs",
"id": "0f1e2d3c-4b5a-4968-8776-a5b4c3d2e1f0",
"person_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"person_name": "Jane Doe",
"product": "endpoint",
"raised_at": "2026-11-10T14:22:05.123Z",
"severity": "high",
"tenant_id": "57ca9a6b-885f-4e36-95ec-290548c26059",
"tenant_name": "Acme Corp",
"type": "Event::Endpoint::Threat::Detected"
}
],
"count": 1,
"has_more": false,
"next_page_key": ""
}List blocked items
List the files blocked from running on every endpoint, with why and who blocked each.
Inputs
- Limit
limitnumber - How many to return, 1 to 100. Defaults to 50.From 1 to 100.
- Page
pagenumber - Which page to read, from 1. Defaults to 1.At least 1.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if another page follows
itemslist- The blocked items on this page
pagenumber- The page read
totalnumber- How many there are on every page
total_pagesnumber- How many pages there are
Example output
{
"count": 1,
"has_more": false,
"items": [
{
"certificate_signer": "",
"comment": "Blocked after the phishing campaign",
"created_at": "2026-11-10T14:40:00.000Z",
"created_by": "Lodol automation",
"file_name": "invoice.exe",
"id": "6e5d4c3b-2a19-4087-b6a5-948372615f4e",
"origin_endpoint_id": "",
"origin_person": "",
"path": "",
"sha256": "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f",
"type": "sha256",
"updated_at": "2026-11-10T14:40:00.000Z"
}
],
"page": 1,
"total": 1,
"total_pages": 1
}List endpoint groups
List the groups endpoints are organised in, by name, with how many endpoints each holds.
Inputs
- Group type
group_typetext - Only computer groups, or only server groups. Leave empty for both.One of:
computer,server. - Search
searchtext - Only groups whose name contains this.
- Limit
limitnumber - How many to return, 1 to 500. Defaults to 50.From 1 to 500.
- Page
pagenumber - Which page to read, from 1. Defaults to 1.At least 1.
Outputs
countnumber- How many are on this page
groupslist- The groups on this page
has_moretrue/false- True if another page follows
pagenumber- The page read
totalnumber- How many there are on every page
total_pagesnumber- How many pages there are
Example output
{
"count": 1,
"groups": [
{
"created_at": "2026-01-15T09:00:00.000Z",
"description": "Laptops used by the finance team",
"endpoint_count": 1,
"endpoint_hostnames": [
"DESKTOP-F82003"
],
"endpoint_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"name": "Finance laptops",
"type": "computer",
"updated_at": "2026-11-01T09:00:00.000Z"
}
],
"has_more": false,
"page": 1,
"total": 1,
"total_pages": 1
}List endpoints
Find computers and servers protected by Sophos, by health, type, isolation, online state, Tamper Protection, group, hostname, person, IP address or when last seen.
Inputs
- Health
health_statuseslist - Only endpoints in these health states.One or more of:
good,suspicious,bad,unknown. - Types
typeslist - Only computers, or only servers. Leave empty for both.One or more of:
computer,server. - Isolation
isolation_statustext - Only isolated endpoints, or only those not isolated. Leave empty for both.One of:
isolated,notIsolated(Not isolated). - Online or offline
onlinetext - Only endpoints talking to Sophos Central now (online), or not. Leave empty for both.One of:
online,offline. - Tamper Protection on
tamper_protection_enabledtrue/false - Turn on for endpoints with Tamper Protection on; leave off for any.
- Endpoint groups
group_idslist - Only endpoints in these groups. Leave empty for every group.
- Hostname contains
hostname_containstext - Only endpoints whose hostname contains this (Sophos matches the first 10 characters).
- Person contains
person_containstext - Only endpoints whose associated person's name contains this.
- IP addresses
ip_addresseslist - Only endpoints with one of these IP addresses.
- Last seen after
last_seen_afterdate and time - Only endpoints that talked to Sophos Central at or after this time.
- Last seen before
last_seen_beforedate and time - Only endpoints that haven't talked to Sophos Central since this time.
- Search
searchtext - Words to look for in the hostname, group, person, IP address, operating system, serial number or tags.
- Limit
limitnumber - How many to return, 1 to 100. Defaults to 50.From 1 to 100.
- Next page key
page_keytext - The 'next_page_key' from the previous page, to read on.
Outputs
countnumber- How many are on this page
endpointslist- The endpoints on this page
has_moretrue/false- True if another page follows
next_page_keytext- Give this as 'Next page key' to read the next page
Example output
{
"count": 1,
"endpoints": [
{
"admin_isolated": false,
"assigned_products": [
{
"code": "interceptX",
"status": "installed",
"version": "2024.3.1.4"
},
{
"code": "coreAgent",
"status": "installed",
"version": "2024.3.1.2"
}
],
"cloud_instance_id": "",
"cloud_provider": "",
"encryption_status": "encrypted",
"group_id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"group_name": "Finance laptops",
"health": "good",
"hostname": "DESKTOP-F82003",
"id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"ipv4_addresses": [
"10.10.10.100"
],
"ipv6_addresses": [
"fe80::9f3e:aeff:8892:bb8"
],
"is_server": false,
"isolation_status": "notIsolated",
"last_agent_update_at": "2026-11-11T02:10:00.000Z",
"last_os_update_at": "2026-11-05T19:00:00.000Z",
"last_seen_at": "2026-11-12T09:41:00.000Z",
"lockdown_status": "",
"mac_addresses": [
"00:0B:FF:E1:C2:C2"
],
"online": true,
"os_name": "Windows 11 Pro",
"os_platform": "windows",
"os_version": "10.0.22631",
"person_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"person_login": "ACME\\jdoe",
"person_name": "Jane Doe",
"self_isolated": false,
"serial_number": "",
"services_health": "good",
"services_not_running": [],
"tags": [
"site:hq"
],
"tamper_protection_enabled": true,
"tamper_protection_supported": true,
"threats_health": "good",
"type": "computer"
}
],
"has_more": false,
"next_page_key": ""
}List events
Read Sophos Central's event log from the last 24 hours, oldest first: threats found and cleaned, endpoints registered, updates failing, web sites blocked and more.
Inputs
- Since
sincedate and time - Only events from this time on, within the last 24 hours. Leave empty for the whole 24 hours.
- Leave out types
exclude_typeslist - Event types to leave out, such as Event::Endpoint::UpdateSuccess.
- Limit
limitnumber - How many to return, 200 to 1,000. Defaults to 200.From 200 to 1000.
- Cursor
cursortext - The 'next_cursor' from the previous page, to read on.
Outputs
countnumber- How many are on this page
eventslist- The events, oldest first
has_moretrue/false- True if another page follows
next_cursortext- Give this as 'Cursor' to read on (also for newer events later)
Example output
{
"count": 1,
"events": [
{
"app_sha256": "275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f",
"created_at": "2026-11-10T14:22:06.010Z",
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"endpoint_type": "computer",
"group": "MALWARE",
"id": "7c2b3a1d-9e8f-4a6b-b5c4-d3e2f1a0b9c8",
"location": "DESKTOP-F82003",
"name": "Malware detected: 'Troj/Agent-BCDE' at 'C:\\Users\\jdoe\\Downloads\\invoice.exe'",
"origin": "ML",
"severity": "high",
"source": "ACME\\jdoe",
"tenant_id": "57ca9a6b-885f-4e36-95ec-290548c26059",
"threat": "Troj/Agent-BCDE",
"type": "Event::Endpoint::Threat::Detected",
"user_id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"when": "2026-11-10T14:22:05.123Z"
}
],
"has_more": false,
"next_cursor": "VjJfQ1VSU09SfDIwMjYtMTEtMTBUMTQ6MjI6MDYuMDEwWg=="
}List users
List the people in Sophos Central's directory, by name, with their email and groups.
Inputs
- Search
searchtext - Only people whose name or email contains this.
- Source
source_typetext - Only people from this directory. Leave empty for all.One of:
custom(Added in Sophos Central),activeDirectory(Active Directory),azureActiveDirectory(Microsoft Entra ID (Azure AD)),googleDirectory(Google Directory). - Limit
limitnumber - How many to return, 1 to 100. Defaults to 50.From 1 to 100.
- Page
pagenumber - Which page to read, from 1. Defaults to 1.At least 1.
Outputs
countnumber- How many are on this page
has_moretrue/false- True if another page follows
pagenumber- The page read
totalnumber- How many there are on every page
total_pagesnumber- How many pages there are
userslist- The users on this page
Example output
{
"count": 1,
"has_more": false,
"page": 1,
"total": 1,
"total_pages": 1,
"users": [
{
"created_at": "2025-03-02T10:15:00.000Z",
"domain": "acme.example",
"email": "jane.doe@acme.example",
"exchange_login": "jdoe",
"first_name": "Jane",
"group_ids": [
"d4c3b2a1-0f9e-4d8c-b7a6-958473625140"
],
"group_names": [
"Finance"
],
"id": "c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f",
"last_name": "Doe",
"manager_name": "Sam Lee",
"name": "Jane Doe",
"source_type": "activeDirectory",
"updated_at": "2026-10-01T08:00:00.000Z"
}
]
}Release endpoints from isolation
Put isolated endpoints back on the network.
Inputs
- Endpoints
endpoint_idslistRequired - The endpoints to release, up to 500.
- Reason
commenttext - Why they're released, shown in Sophos Central (up to 400 characters).
Outputs
accepted_countnumber- How many Sophos accepted
accepted_idslist- The endpoints Sophos accepted
endpoint_idslist- The endpoints it was asked about
errorslist- The endpoints it didn't accept
Example output
{
"accepted_count": 1,
"accepted_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"endpoint_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"errors": []
}Remove endpoints from group
Take endpoints out of a group. They stay protected, in no group.
Inputs
- Endpoint group
group_idtextRequired - The group, chosen by name, or its id from 'List endpoint groups'.
- Endpoints
endpoint_idslistRequired - The endpoints to remove.
Outputs
group_idtext- The group
not_foundlist- Ids that weren't in the group
removedlist- The endpoints removed
removed_countnumber- How many were removed
Example output
{
"group_id": "9a8b7c6d-5e4f-4a3b-9c2d-1e0f9a8b7c6d",
"not_found": [],
"removed": [
{
"hostname": "DESKTOP-F82003",
"id": "4f725e46-a174-45a7-a352-49ed15840ab1"
}
],
"removed_count": 1
}Scan endpoints
Start a scan on each endpoint. Any threat it finds is raised as an alert.
Inputs
- Endpoints
endpoint_idslistRequired - The endpoints to scan, up to 500.
Outputs
endpoint_idslist- The endpoints it was asked to scan
errorslist- The endpoints it didn't accept
requestedlist- The scans Sophos accepted
requested_countnumber- How many it accepted
Example output
{
"endpoint_ids": [
"4f725e46-a174-45a7-a352-49ed15840ab1"
],
"errors": [],
"requested": [
{
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"requested_at": "2026-11-10T14:35:00.000Z",
"status": "requested"
}
],
"requested_count": 1
}Unblock file
Remove a blocked item, so the file may run again.
Inputs
- Blocked item ID
item_idtextRequired - The blocked item's id, from 'List blocked items' or 'Block file'.
Outputs
deletedtrue/false- True once it is removed
item_idtext- The blocked item
Example output
{
"deleted": true,
"item_id": "6e5d4c3b-2a19-4087-b6a5-948372615f4e"
}Update Tamper Protection
Turn Tamper Protection on or off for an endpoint, make a new password for it, or both.
Inputs
- Endpoint
endpoint_idtextRequired - The endpoint, chosen by name, or its id from 'List endpoints', an alert's endpoint_id or a trigger.
- Tamper Protection
statetext - Turn it on or off. Leave empty to keep it as it is.One of:
on(Turn on),off(Turn off). - Make a new password
regenerate_passwordtrue/false - Turn on to replace the endpoint's Tamper Protection password.
Outputs
enabledtrue/false- True if Tamper Protection is on
endpoint_idtext- The endpoint
passwordtext- The current Tamper Protection password
previous_passwordslist- Old passwords
Example output
{
"enabled": true,
"endpoint_id": "4f725e46-a174-45a7-a352-49ed15840ab1",
"password": "8sK2pQ9vX4mT",
"previous_passwords": [
{
"invalidated_at": "2026-10-01T08:00:00.000Z",
"password": "r7Lw3nB6cJ1z"
}
]
}