SafeBreach

this connector integrates safebreach api with swimlane turbine the safebreach breach and attack simulation (bas) platform allows you to continuously validate all layers of your security by simulating real world attacks to identify gaps in controls, prioritize and reveal actual risk prerequisites the safebreach connector asset requires an url and an api token to interact with the api capabilities this connector provides the following capabilities add simulation label delete simulation label delete test summary get detailed test summaries get execution history suggestions get executions history results get service status get simulation stats regarding path between nodes get simulations labels list vulnerability detections for all simulators post simulation stats regarding path between nodes return insight list return insight through post includes filters return remediation data for a specified insight return remediation data through post and so on notes https //www postman com/safebreach product api/workspace/safebreach api/collection/20710976 5e3423ef 0bbd 4c8d 927f 14b08fcbb8f3 https //www elastic co/guide/en/elasticsearch/reference/current/query dsl query string query html#query string syntax configurations safebreach api key authentication authenticates using an api key configuration parameters parameter description type required url a url to the target host string required x apitoken api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add simulation label add a label to the specified simulation endpoint url /api/data/v1/accounts/{{accountid}}/rt/simulation/{{simulationid}}/labels/{{labelvalue}} method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters simulationid string required parameters for the add simulation label action path parameters labelvalue string required parameters for the add simulation label action parameters planrunid string optional the test run id for which the operation is required, otherwise, use executions table input example {"parameters" {"planrunid" ""},"path parameters" {"accountid" 1,"simulationid" "","labelvalue" ""}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data data labelvalue string response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"data" {"labelvalue" "\<string>"}}} delete simulation label delete a specified tag from a specified simulation endpoint url /api/data/v1/accounts/{{accountid}}/rt/simulation/{{simulationid}}/labels/{{labelvalue}} method delete input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters simulationid string required parameters for the delete simulation label action path parameters labelvalue string required parameters for the delete simulation label action parameters planrunid string optional the test run id for which the operation is required, otherwise, use executions table input example {"parameters" {"planrunid" ""},"path parameters" {"accountid" 1,"simulationid" "","labelvalue" ""}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data data labelvalue string response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"data" {"labelvalue" ""}}} delete test summary delete the specified test summary and all the results associated with it endpoint url /api/data/v1/accounts/{{accountid}}/tests/{{planrunid}} method delete input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters planrunid string required parameters for the delete test summary action parameters softdelete boolean optional if true, test summary will be marked as deleted and if false, test summary will be deleted from the database input example {"parameters" {"softdelete"\ true},"path parameters" {"accountid" 1,"planrunid" ""}} output parameter type description status code number http status code of the response reason string response reason phrase status string status value output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"status" ""}} get detailed test summaries return all detailed test summaries endpoint url /api/data/v1/accounts/{{accountid}}/detailedtestsummaries method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters planrunids string required a list of tests runids to filter by the elements needs to be separated by pipes ( ) input example {"parameters" {"planrunids" ""},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[\[{},{}],\[{},{}]]} get execution history suggestions returns the executions history suggestions endpoint url /api/data/v1/accounts/{{accountid}}/executionshistorysuggestions method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys input example {"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 12,"srcnodeostype" "","movetags" {},"paramsstr" "","id" "","packagename" "","srcnodename" "","moveid" 1,"matrixid" 2,"destnodeostype" ""},{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" get executions history results returns the executions history results endpoint url /api/data/v1/accounts/{{accountid}}/executionshistoryresults method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters runid string required the run id for the operation parameters id string optional the id of the execution history record parameters query string optional the search query for executions see readme for further details parameters pagesize number optional page size for response paging if omitted, default page size will be used, if page exists otherwise, all results will be returned parameters page number optional page number from the results, starting from 1 if omitted, and page size parameter exists, first page is returned if both omitted, all results are returned parameters filetype string optional if exists, the result will be provided as a file type instead of json input example {"parameters" {"runid" "","id" "","query" "","pagesize" 300,"page" 1,"filetype" "csv"},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" "","movetags" {},"paramsstr" "","id" "","packagename" "","srcnodename" "","moveid" 2,"matrixid" 3,"destnodeostype" ""},{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" get service status return the current connection status of all system services endpoint url /api/data/v1/status method get output parameter type description status code number http status code of the response reason string response reason phrase data object response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"data" {}}} get simulation stats regarding path between nodes returns list of edges between nodes, and number or methods on each edge endpoint url /api/data/v1/accounts/{{accountid}}/breachexplorer method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters planrunids string optional a list of tests runids to filter by the elements needs to be separated by pipes ( ) input example {"parameters" {"planrunids" ""},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results attackernodeid number unique identifier results targetnodeid number unique identifier results packageid number unique identifier results count number result of the operation output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"results" \[{},{}]}} get simulations labels returns simulations labels endpoint url /api/data/v1/accounts/{{accountid}}/executionshistory/labels method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys input example {"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"labelid" "","labelname" ""},{"labelid" "","labelname" ""}]} list vulnerability detections for all simulators return list of vulnerability detections for all simulators end fragment endpoint url /api/data/v1/accounts/{{accountid}}/vulnerabilities method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters runids string optional a list of tests run ids to filter by the elements needs to be separated by pipes ( ) sort object optional parameter for list vulnerability detections for all simulators sort severity number optional parameter for list vulnerability detections for all simulators sort criticalpercent number optional parameter for list vulnerability detections for all simulators sort distance from infiltration number optional parameter for list vulnerability detections for all simulators sort direct access number optional parameter for list vulnerability detections for all simulators sort distance to critical number optional parameter for list vulnerability detections for all simulators sort attack surface number optional parameter for list vulnerability detections for all simulators filter object optional parameter for list vulnerability detections for all simulators filter severity object optional parameter for list vulnerability detections for all simulators filter severity type string optional type of the resource filter severity value array optional value for the parameter filter criticalpercent object optional parameter for list vulnerability detections for all simulators filter criticalpercent type string optional type of the resource filter criticalpercent value array optional value for the parameter filter distance from infiltration object optional parameter for list vulnerability detections for all simulators filter distance from infiltration type string optional type of the resource filter distance from infiltration value array optional value for the parameter filter direct access object optional parameter for list vulnerability detections for all simulators filter direct access type string optional type of the resource filter direct access value array optional value for the parameter filter distance to critical object optional parameter for list vulnerability detections for all simulators filter distance to critical type string optional type of the resource filter distance to critical value array optional value for the parameter input example {"parameters" {"runids" ""},"json body" {"sort" {"severity" 6,"criticalpercent" 1,"distance from infiltration" 2,"direct access" 3,"distance to critical" 4,"attack surface" 5},"filter" {"severity" {"type" "","value" \[6,7]},"criticalpercent" {"type" "","value" \[8,9]},"distance from infiltration" {"type" "","value" \[1,2]},"direct access" {"type" "","value" \[3,4]},"distance to critical" {"type" "","value" \[1,2]},"attack surface" {"type" "","value" \[1,2]},"cvss2" {"type" "","value" \[1,2]}},"refresh"\ true},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase sort object output field sort sort severity number output field sort severity sort criticalpercent number output field sort criticalpercent sort distance from infiltration number output field sort distance from infiltration sort direct access number output field sort direct access sort distance to critical number output field sort distance to critical sort attack surface number output field sort attack surface filter object output field filter filter severity object output field filter severity filter severity type string type of the resource filter severity value array value for the parameter filter criticalpercent object output field filter criticalpercent filter criticalpercent type string type of the resource filter criticalpercent value array value for the parameter filter distance from infiltration object output field filter distance from infiltration filter distance from infiltration type string type of the resource filter distance from infiltration value array value for the parameter filter direct access object output field filter direct access filter direct access type string type of the resource filter direct access value array value for the parameter filter distance to critical object output field filter distance to critical filter distance to critical type string type of the resource filter distance to critical value array value for the parameter output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"sort" {"severity" 1,"criticalpercent" 2,"distance from infiltration" 3,"direct access" 4,"distance to critical" 5,"attack surface" 6},"filter" {"severity" {},"criticalpercent" {},"distance from infiltration" {},"direct access" {},"distance to critical" {},"attack surface" {},"cvss2" {}},"refresh"\ true}} post simulation stats regarding path between nodes returns list of edges between nodes, and number or methods on each edge endpoint url /api/data/v1/accounts/{{accountid}}/breachexplorer method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys planrunids array optional unique identifier input example {"json body" {"planrunids" \["string","string"]},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase results array result of the operation results attackernodeid number unique identifier results targetnodeid number unique identifier results packageid number unique identifier results count number result of the operation output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"results" \[{},{}]}} return insight list retrieve the remediation data for an insight based on specified parameters such as simulators involved and type of insight or file endpoint url /api/data/v1/accounts/{{accountid}}/insights method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters type string optional if exists, type of insights \[actionbased, locationbased] parameters attackersnodesids string optional a list of attackers nodes to filter by the elements needs to be separated by pipes ( ) parameters targetnodesids string optional a list of targets nodes to filter by the elements needs to be separated by pipes ( ) parameters planrunids string optional a list of tests runids to filter by the elements needs to be separated by pipes ( ) parameters filetype string optional the type of result file returned by the request, if not assigned the response will return in a json string format input example {"parameters" {"type" "locationbased","attackersnodesids" "","targetnodesids" "","planrunids" "","filetype" "csv"},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" 1,"accountid" 2,"name" "","priority" 3,"title" "","category" "","attacker" "","isexternal"\ true,"target" "","iscritical"\ true,"isenabled"\ true,"criteria" "","remediation" "","attacktypes" "","attackphases" ""},{"id" 1,"accountid" 2,"name" "","priority" 3,"title" "","category" "","attacker" "","isexternal"\ true,"target" "","iscrit return insight through post includes filters return the list of insights through post action endpoint url /api/data/v1/accounts/{{accountid}}/insights method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys filters array optional parameter for return insight through post includes filters filters key string optional parameter for return insight through post includes filters filters timerange object optional parameter for return insight through post includes filters filters size number optional parameter for return insight through post includes filters type string optional type of the resource input example {"json body" {"filters" \[{"key" "","timerange" {},"size" 3},{"key" "","timerange" {},"size" 1}],"type" ""},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" 1,"accountid" 2,"name" "","priority" 3,"title" "","category" "","attacker" "","isexternal"\ true,"target" "","iscritical"\ true,"isenabled"\ true,"criteria" "","remediation" "","attacktypes" "","attackphases" ""},{"id" 3,"accountid" 4,"name" "","priority" 5,"title" "","category" "","attacker" "","isexternal"\ true,"target" "","iscrit return remediation data for a specified insight return the remediation data for a specified insight endpoint url /api/data/v1/accounts/{{accountid}}/insights/{{insightid}}/remediation method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters insightid number required parameters for the return remediation data for a specified insight action parameters targetnodeid string optional the target node id used for remediation calculation parameters type string optional if exists, type of insights \[actionbased, locationbased] parameters attackersnodesids string optional a list of attackers nodes to filter by the elements needs to be separated by pipes ( ) parameters vendor string optional an indication for the remediation data export format parameters planrunids string optional a list of tests runids to filter by the elements needs to be separated by pipes ( ) input example {"parameters" {"targetnodeid" "","type" "locationbased","attackersnodesids" "","vendor" "paloalto","planrunids" ""},"path parameters" {"accountid" 1,"insightid" 2}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[]} return remediation data through post get remediation data through post endpoint url /api/data/v1/accounts/{{accountid}}/insights/{{insightid}}/remediation method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters insightid number required parameters for the return remediation data through post action planrunids array optional unique identifier attackersnodesids array optional unique identifier targetnodeid string optional unique identifier type string optional type of the resource vendor string optional parameter for return remediation data through post input example {"json body" {"planrunids" \["",""],"attackersnodesids" \["",""],"targetnodeid" "","type" "locationbased","vendor" "atp"},"path parameters" {"accountid" 1,"insightid" 2}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {}} return report definitions returns a list of report definitions endpoint url /api/data/v1/accounts/{{accountid}}/reports method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys headers object required http headers for the request headers x deployment ids string required scope query for deployment input example {"path parameters" {"accountid" 1},"headers" {"x deployment ids" "1,1"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"reportid" 1,"reportname" "","reportdescription" "","shortdescription" "","icon" ""},{"reportid" 2,"reportname" "","reportdescription" "","shortdescription" "","icon" ""}]} return report layout returns the report layout endpoint url /api/data/v1/accounts/{{accountid}}/reports/{{reportid}}/layout method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters reportid number required parameters for the return report layout action input example {"path parameters" {"accountid" 1,"reportid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase rows array output field rows rows columns array output field rows columns rows columns rows array output field rows columns rows rows columns rows value string value for the parameter rows columns width object unique identifier rows columns width xs number unique identifier rows columns width sm number unique identifier rows columns width md number unique identifier rows columns width lg number unique identifier rows columns widget object unique identifier rows columns widget type string unique identifier rows columns widget title object unique identifier rows columns widget title title string unique identifier rows columns widget title style string unique identifier rows columns widget ds string unique identifier rows columns widget settings object unique identifier rows columns widget settings description string unique identifier rows columns repeat object output field rows columns repeat rows columns repeat name string name of the resource rows columns repeat foreach string output field rows columns repeat foreach rows repeat object output field rows repeat rows repeat name string name of the resource rows repeat foreach string output field rows repeat foreach output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"rows" \[{},{}]}} return report parameters returns a list of report parameters endpoint url /api/data/v1/accounts/{{accountid}}/reports/{{reportid}}/params method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters reportid number required parameters for the return report parameters action input example {"path parameters" {"accountid" 1,"reportid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" "","name" "","description" "","type" "","items" "","values" \[],"def" {},"hidden"\ true},{"id" "","name" "","description" "","type" "","items" "","values" \[],"def" {},"hidden"\ true}]} return simulator statistics per simulator pair returns list of edges between nodes, and number or methods on each edge endpoint url /api/data/v1/accounts/{{accountid}}/risk method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters packageid number optional attack type parameters kri string required which type of kri matching the security posture report input example {"parameters" {"packageid" 1,"kri" "knownattacks"},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"targetnodeid" "","attackernodeid" "","success" 1,"fail" 0},{"targetnodeid" "","attackernodeid" "","success" 1,"fail" 0}]} return step summary return the summary info for a step within a test endpoint url /api/data/v1/accounts/{{accountid}}/stepsummary/{{steprunid}} method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters steprunid string required parameters for the return step summary action input example {"path parameters" {"accountid" 1,"steprunid" ""}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" "","matrixname" "","matrixid" 1,"userid" 109,"isscheduled"\ true,"iscompleted"\ true,"comment" "","status" "","blocked" 2,"constraintsskipped" 3,"assumedblocked" 4,"notblocked" 5,"internalfail" 6,"starttime" 7,"endtime" ""},{"id" "","matrixname" "","matrixid" 1,"userid" 109,"isscheduled"\ true,"iscompleted"\ true,"comment" "","status return test running info return the number of simulations which were blocked, not blocked, and with no results for the specified test endpoint url /api/data/v1/accounts/{{accountid}}/matrices/{{matrixid}}/stats method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters matrixid number required parameters for the return test running info action parameters fromdate string required the execution date to start looking from parameters todate string required the upper limit of execution time to search for documents input example {"parameters" {"fromdate" "2023 11 28t04 24 00 121z","todate" "2023 12 28t04 24 00 121z"},"path parameters" {"accountid" 1,"matrixid" 2}} output parameter type description status code number http status code of the response reason string response reason phrase blockedsimulations number output field blockedsimulations unblockedsimulations number output field unblockedsimulations failedsimulations number output field failedsimulations output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"blockedsimulations" 1,"unblockedsimulations" 2,"failedsimulations" 3}} return test summary return the test summary info for a specific test end fragment endpoint url /api/data/v1/accounts/{{accountid}}/testsummaries/{{planrunid}} method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters planrunid string required parameters for the return test summary action input example {"path parameters" {"accountid" 1,"planrunid" ""}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" "","matrixname" "","matrixid" 1,"userid" 109,"isscheduled"\ true,"iscompleted"\ true,"comment" "","status" "","blocked" 2,"constraintsskipped" 3,"assumedblocked" 4,"notblocked" 5,"internalfail" 6,"starttime" 7,"endtime" ""},{"id" "","matrixname" "","matrixid" 1,"userid" 12345,"isscheduled"\ true,"iscompleted"\ false,"comment" "","sta return test summary list return a list of all test summaries endpoint url /api/data/v1/accounts/{{accountid}}/testsummaries method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters planid number optional the plan id as appears in the plan parameters status string optional the plan status parameters size number optional the amount of plan summaries to return parameters simulationid string optional the unique identifier of a single simulation parameters sortby string optional the sortby field summaries without this field will be removed input example {"parameters" {"planid" 1,"status" "","size" 100,"simulationid" "","sortby" "endtime"},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[\[{},{}],\[{},{}]]} returns execution history suggestions through post returns the executions suggestions through post endpoint url /api/data/v1/accounts/{{accountid}}/executionshistorysuggestions method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys runid string optional unique identifier query string optional parameter for returns execution history suggestions through post input example {"json body" {"runid" "","query" ""},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" "","movetags" {},"paramsstr" "","id" "","packagename" "","srcnodename" "","moveid" 2,"matrixid" 3,"destnodeostype" ""},{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" returns mitre stats returns mitre stats endpoint url /api/data/v1/accounts/{{accountid}}/mitre/stats method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys parameters query string optional the search query for executions see readme for further details input example {"parameters" {"query" ""},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"name" "","id" "","sort" 1,"alerts" 2,"result" {},"status" {},"mitretechniques" \[]},{"name" "","id" "","sort" 1,"alerts" 2,"result" {},"status" {},"mitretechniques" \[]}]} returns the dashboards query through post returns the dashboards query endpoint url /api/data/v1/accounts/{{accountid}}/dashboards method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys label string optional parameter for returns the dashboards query through post id string optional unique identifier queryargs array optional parameter for returns the dashboards query through post queryargs key string optional parameter for returns the dashboards query through post queryargs timerange object optional parameter for returns the dashboards query through post queryargs size number optional parameter for returns the dashboards query through post chart string optional parameter for returns the dashboards query through post time string optional time value showna boolean optional parameter for returns the dashboards query through post issplit boolean optional parameter for returns the dashboards query through post orderby object optional parameter for returns the dashboards query through post filters array optional parameter for returns the dashboards query through post filters key string optional parameter for returns the dashboards query through post filters value array optional value for the parameter input example {"json body" {"label" "","id" "","queryargs" \[{"key" "","timerange" {},"size" 7},{"key" "","timerange" {},"size" 8}],"chart" "","time" "","showna"\ true,"issplit"\ true,"orderby" {},"filters" \[{"key" "","value" \["",""]},{"key" "","value" \["",""]}]},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase hits object output field hits aggregations object output field aggregations fugiat cd string output field fugiat cd output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"hits" {},"aggregations" {},"fugiat cd" "irure labore mollit occaecat"}} returns the execution history results through post returns the executions history results endpoint url /api/data/v1/accounts/{{accountid}}/executionshistoryresults method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys runid string optional unique identifier id string optional unique identifier query string optional parameter for returns the execution history results through post pagesize number optional parameter for returns the execution history results through post page number optional parameter for returns the execution history results through post filetype string optional type of the resource input example {"json body" {"runid" "","id" "","query" "","pagesize" 300,"page" 1,"filetype" "csv"},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" "","movetags" {},"paramsstr" "","id" "","packagename" "","srcnodename" "","moveid" 2,"matrixid" 3,"destnodeostype" ""},{"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" returns the executions returns the executions endpoint url /api/data/v1/accounts/{{accountid}}/simulationssummaryresults method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys query string optional parameter for returns the executions parsedquery string optional parameter for returns the executions simulationsids array optional unique identifier methodids array optional http method to use input example {"json body" {"query" "","parsedquery" "","simulationsids" \["",""],"methodids" \[1,2]},"path parameters" {"accountid" 1}} output parameter type description status code number http status code of the response reason string response reason phrase runid string unique identifier output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"runid" ""}} returns the executions of test specified by id returns the executions of the test specified by the id endpoint url /api/data/v1/accounts/{{accountid}}/executionshistoryresults/{{id}} method get input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters id string required parameters for the returns the executions of test specified by id action parameters runid string required the run id(test id) which the simulation belongs to input example {"parameters" {"runid" ""},"path parameters" {"accountid" 1,"id" ""}} output parameter type description status code number http status code of the response reason string response reason phrase movetagids object unique identifier resultcode string result of the operation resultdetails string result of the operation data string response data destnodename string name of the resource methodid number http method to use srcnodeostype string type of the resource movetags object output field movetags paramsstr string output field paramsstr id string unique identifier packagename string name of the resource srcnodename string name of the resource moveid number unique identifier matrixid number unique identifier destnodeostype string type of the resource packageid number unique identifier params string output field params labels array output field labels assettype string type of the resource srcnodeid string unique identifier destnodeid string unique identifier executiontime string time value latestexec string output field latestexec output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"movetagids" {},"resultcode" "","resultdetails" "","data" "","destnodename" "","methodid" 1,"srcnodeostype" "","movetags" {},"paramsstr" "","id" "","packagename" "","srcnodename" "","moveid" 2,"matrixid" 3,"destnodeostype" ""}} run a report run a single report, with specified parameters endpoint url /api/data/v1/accounts/{{accountid}}/reports/{{reportid}}/generator method post input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters reportid number required parameters for the run a report action parameters outputformat string required the output format for the report can be 'json' headers object required http headers for the request headers x deployment ids string required scope query for deployment params array optional parameter for run a report params prm string optional parameter for run a report params vals array optional parameter for run a report params vals description string optional parameter for run a report datasets array optional response data datasets id string optional response data datasets page number optional response data datasets pagesize number optional response data runids array optional unique identifier input example {"parameters" {"outputformat" "json"},"json body" {"params" \[{"prm" "","vals" \[{"description" "parameter value"},{"description" "parameter value"}]},{"prm" "","vals" \[{"description" "parameter value"},{"description" "parameter value"}]}],"datasets" \[{"id" "","page" 1,"pagesize" 2},{"id" "","page" 3,"pagesize" 4}],"runids" \["",""]},"path parameters" {"accountid" 1,"reportid" 1},"headers" {"x deployment ids" "1,1"}} output parameter type description status code number http status code of the response reason string response reason phrase output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" \[{"id" "","total" 1,"results" \[]},{"id" "","total" 2,"results" \[]}]} update test summary update the test summary information end fragment endpoint url /api/data/v1/accounts/{{accountid}}/testsummaries/{{planrunid}} method put input argument name type required description path parameters accountid number required safebreach account id located in administration > api keys path parameters planrunid string required parameters for the update test summary action parameters userid number optional the fields to update comment string optional parameter for update test summary input example {"parameters" {"userid" 3},"json body" {"comment" ""},"path parameters" {"accountid" 1,"planrunid" ""}} output parameter type description status code number http status code of the response reason string response reason phrase data object response data data planrunid string response data data comment string response data output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "mon, 15 apr 2024 20 37 23 gmt"},"reason" "ok","json body" {"data" {"planrunid" "","comment" ""}}} response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated mon, 15 apr 2024 20 37 23 gmt