You can access the simulation raw data using the Rest API. Scope of the API includes; Simulation list, Simulation Details, Threat/Objective/Action Results, Results mapped to MITRE ATTC&K and Unified Kill Chain frameworks, Detection Analysis Results, Validated Logs & Alerts with SIEM & EDR integration.
\nOAuth2 protocol is used to authorize Refresh/Access tokens. To obtain the API, you should generate a refresh token and then request an access token using the /v1/auth/token endpoint. The refresh token will be valid for 6 months, whereas the access token will be available for 2 hours. After getting the access token, add Authorization: Bearer {accessToken} to the header to request access to the below endpoints.
\nEndpoints returning data with a lot of load works with the pagination method. You can use the offset and limit parameters to get the correct page.
\n\nYour usage will be limited with your Picus license.", "title": "Picus Rest API", "version": "1.0" }, "paths": { "/v2/simulations/{Id}/results/reports": { "post": { "security": [ { "Access-Token": [] } ], "description": "Generates a report for the specified simulation. The report can either provide an overview or focus on a specific run of the simulation, depending on the parameters.", "tags": [ "Simulation-Result-Reports" ], "summary": "# Generate Simulation Report", "operationId": "generateSimulationReportParams", "parameters": [ { "description": "Simulation ID", "name": "Id", "in": "path", "required": true, "schema": { "type": "integer", "format": "uint64" } }, { "x-go-name": "Type", "description": "Type of the report. One of: 'run' | 'overview'", "name": "type", "in": "query", "required": true, "schema": { "type": "string" } }, { "x-go-name": "RunId", "description": "Id of the run or 'latest'. Required if type is 'run'", "name": "runId", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateSimulationReportInput" } } } }, "responses": { "200": { "$ref": "#/components/responses/GenerateSimulationReportResponse" }, "401": { "$ref": "#/components/responses/unauthorizedErrorSwagger" }, "422": { "$ref": "#/components/responses/validationErrorSwagger" }, "default": { "$ref": "#/components/responses/genericErrorSwagger" } } } } }, "security": [ { "Access-Token": [] } ], "servers": [ { "url": "https://api.picussecurity.com" } ], "components": { "responses": { "GenerateSimulationReportResponse": { "description": "GenerateSimulationReportResponse", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SimulationReportBasicOutput" } } } } }, "genericErrorSwagger": { "description": "genericErrorSwagger is represents the erroneous cases", "content": { "application/json": { "schema": { "type": "object", "properties": { "error_code": { "description": "Error Code is optional. It is using for define specific error types.", "type": "integer", "format": "int64", "x-go-name": "ErrorCode", "example": 1001 }, "errors": { "description": "Errors are optional. If there are multiple error, this field gives details.", "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "Errors", "example": "[\"error1\", \"error2\"]" }, "message": { "description": "Error Message that contains information about error", "type": "string", "x-go-name": "Message" } } } } } }, "unauthorizedErrorSwagger": { "description": "unauthorizedErrorSwagger is represents unauthorized error", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string", "x-go-name": "Message", "example": "unauthorized error" } } } } } }, "validationErrorSwagger": { "description": "validationErrorSwagger is represents the erroneous cases", "content": { "application/json": { "schema": { "type": "object", "properties": { "errors": { "description": "Validation Error List", "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "Errors", "example": { "param": "tag=max, param=25, given value=1000" } }, "message": { "description": "Message will be \"validation error\"", "type": "string", "x-go-name": "Message", "example": "validation error" } } } } } } }, "securitySchemes": { "Access-Token": { "description": "After getting the access token, type Bearer accessToken to the Value input box to request access to the below endpoints For example Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9", "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "GenerateSimulationReportInput": { "type": "object", "properties": { "format": { "description": "Corresponding report will be generated for each format specified. Available formats: PDF, CSV", "type": "array", "items": { "type": "string" }, "x-go-name": "Formats", "example": [ "PDF" ] }, "includesSensitiveData": { "description": "If false, generated report will display threat information with access links (Only for CSV reports)", "type": "boolean", "x-go-name": "IncludesSensitiveData" }, "onlyPrevention": { "description": "If true, generated report will include only prevention results", "type": "boolean", "x-go-name": "OnlyPrevention" } }, "x-go-package": "github.com/picusnext/picus-digital/go/customer-api/internal_request/customer_api_dto" }, "SimulationReportBasicOutput": { "type": "object", "properties": { "format": { "description": "Report Format. One of: 'PDF' | 'CSV'", "type": "string", "x-go-name": "Format", "example": "PDF" }, "id": { "description": "Report Id", "type": "integer", "format": "uint64", "x-go-name": "ID", "example": 1 }, "status": { "description": "Report Status. One of: 'IN PROGRESS' | 'COMPLETED' | 'ERROR'", "type": "string", "x-go-name": "Status", "example": "COMPLETED" } }, "x-go-package": "github.com/picusnext/picus-digital/go/customer-api/internal_request/customer_api_dto" } } } } ```