Welcome to SafeBreach API Documentation

Sections

Return Test Summary list

Header Parameters

Acceptstring
x-apitokenstring

Query Parameters

includeArchivedstring

This field has been deprecated. Deleted tests are no longer archived.

planIdstring

The plan ID as appears in the plan

statusstring

The plan status

sizestring

The amount of plan summaries to return

simulationIdstring

The unique identifier of a single simulation

sortBystring

Sort by the following values: "startTime", "endTime" - summaries without this field will be removed

testsFinishedBystring

tests finished By field

testsFinishedAfterstring

tests finished after field

querystring

A search query to filter test summaries using Elasticsearch Query String syntax. Supports Boolean operators, wildcards, and field searches. See the Elasticsearch Query String Guide for details.

includeDraftstring

When true, includes results from draft tests

Path Parameters

accountIdstring Required

The unique identifier of the customer account for which the operation is required

Response

200
Object

Response Attributes

idstring
matrixNamestring
matrixIdstring
userIdstring
isScheduledstring
isCompletedstring
commentstring
statusstring
blockedstring
constraintsSkippedstring
notBlockedstring
retryCountstring
internalFailstring
siemCorrelationEndTimestring
durationstring
historyIndexLimitSizeInBytesstring
historyIndexSizeInBytesstring
simulationIdstring
totalNumberOfSimulatorsstring
simulatorExecutionsarray
securityActionPerControlarray
siemProcessingEndTimestring
finalStatusobject
500
Object

Response Attributes

codestring
messagestring
fieldsstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?