Welcome to SafeBreach API Documentation

Sections

Drift by Security Control

Header Parameters

Content-Typestring
Acceptstring
x-apitokenstring

Path Parameters

accountIdstring

The SafeBreach Account ID where the tests were performed

Body Parameters

windowStartstring

(Optional) Start of the search window. Must be in ISO-8601 UTC format. Default: 7 days before windowEnd.

windowEndstring

(Optional) End of the search window. Must be in ISO-8601 UTC format. Default: now.

securityControlstring

(Required) Name of the product/security-control to analyze.

maxOutsideWindowExecutionsstring

(Optional) Number of executions outside the main window to include per tracking ID for context. Default: 1. Recommended to reduce response size and improve performance under heavy load.

earliestSearchTimestring

(Optional) Earliest time to search before windowStart per tracking ID. Must be in ISO-8601 UTC format. Default: 30 days before windowStart. It is highly recommended to use a narrow time window, as it can significantly improve response time.

driftTypestring

(Optional) Filter by drift type, for example, regression, improvement, or mixedDrift.

fromStatusobject

Filter: Source-status object; keys like logged, reported, prevented, alerted with boolean values. Omit = ANY. (e.g., { "logged": true, "reported": false, "prevented": false })

toStatusobject

Filter: Destination-status object; keys like logged, reported, prevented, alerted with boolean values. Omit = ANY. (e.g., { "logged": true, "reported": false, "prevented": false })

containsTransitionstring

Filter: If true, match tracking IDs that contain at least one occurrence of the defined transition. Mutually exclusive with startsAndEndsWithTransition — only one can be true.

startsAndEndsWithTransitionstring

Filter: If true, match tracking IDs that contain at least one occurrence of the defined transition. Mutually exclusive with containsTransition — only one can be true.

attackIdstring

(Optional) Filter by a specific attack or move ID (query-level filter)

attackNamestring

(Optional) Filter by attack name (query-level filter). Must be non-empty.

attackTypestring

(Optional) Filter by attack type display name (for example, "Malware Drop"). Query-level filter. Must be non-empty.

Response

200
Object

Response Attributes

trackingIdstring
attackIdstring
attackNamestring
attackTypesarray
driftTypestring
fromobject
toobject
attackTypestring
500
Object

Response Attributes

codestring
messagestring
fieldsstring
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?