Endpoint API¶

Query computers and servers belonging to a tenant, and perform routine actions on them.

See the guide for a narrative walkthrough of this API.

Base URL¶

https://api-{dataRegion}.central.sophos.com/endpoint/v1 — Regional service in the production environment.

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:

• blocked-ips:read
• blocked-ips:write
• endpoint-computer-tag-management:write OR endpoint-server-tag-management:write
• endpoint-computer:delete OR endpoint-server:delete
• endpoint-diagnose:create
• endpoint-diagnose:read
• endpoint-groups:create
• endpoint-groups:delete
• endpoint-groups:read
• endpoint-groups:update
• endpoint-migration:create
• endpoint-migration:read
• endpoint-policy:create
• endpoint-policy:delete
• endpoint-policy:read
• endpoint-policy:update
• endpoint-policy:update OR endpoint-policy:assign
• endpoint-server:update OR endpoint-computer:update
• endpoint-state:delete
• endpoint-state:read
• endpoint-state:update
• endpoint-versions:read
• endpoint-versions:update

Operations¶

Adaptive Attack Protection¶

Allowed Items¶

Blocked Addresses¶

Blocked Items¶

Device Software¶

See Guide for more on Device Software.

Downloads¶

Endpoint Groups Management¶

See Guide for more on Endpoint Groups Management.

Endpoint Isolation¶

Endpoint Tags¶

See Guide for more on Endpoint Tags.

Endpoints¶

Event Journal¶

Exploit Mitigation¶

Forensic Logs¶

Global Tamper Protection¶

Intrusion Prevention¶

Isolation Exclusions¶

Memory Dump¶

Migrations¶

See Guide for more on Migrations.

Packages¶

See Guide for more on Packages.

Peripheral Control¶

Policy Management¶

See All Policy Settings for more on Policy Management. See Policy Settings Changelog for more on Policy Management. See Policy Settings Object Schemas for more on Policy Management. See Application Control Categories for more on Policy Management. See Assigned Software Packages for more on Policy Management.

Scanning Exclusions¶

Scans¶

Tamper Protection¶

Update Checks¶

Web Control¶

Download¶

• OpenAPI spec