{ "openapi": "3.0.1", "x-hideTryItPanel": true, "info": { "title": "Cortex XSOAR 6 API", "description": "This is the public REST API to integrate with the Cortex XSOAR server.\nHTTP request can be sent using any HTTP-client.\n\nFor an example dedicated client take a look at the [Demisto Client for Python](https://github.com/demisto/demisto-py).\n\nRequests must include an API key, which can be generated in Cortex XSOAR under 'Settings & Info' -> 'Integrations' -> 'API Keys'\n\nOptimistic Locking and Versioning:\n\nWhen using the Cortex XSOAR REST API, ensure you are working on the latest version of the item (incident, entry, etc.) to avoid getting a database version error that will prevent you from overriding a newer item. To force a data override, you can pass 'version: -1'. This causes any newer data to be overridden.\n\nExample request using 'curl'\\:\n\n```\n\ncurl 'https://hostname:443/incidents/search' -H 'content-type: application/json' -H 'accept: application/json' -H 'Authorization: ' --data-binary '{\"filter\":{\"query\":\"-status:closed -category:job\",\"period\":{\"by\":\"day\",\"fromValue\":7}}}' --compressed\n\n```", "version": "6" }, "servers": [ { "url": "https://hostname" } ], "tags": [ { "name": "API Keys", "description": "APIs for managing API keys" }, { "name": "Audit Log", "description": "APIs for audit logs" }, { "name": "Authentication", "description": "APIs for managing user sessions and sign-out" }, { "name": "Content Packs", "description": "APIs for content packs" }, { "name": "Dashboards", "description": "APIs for managing dashboards" }, { "name": "Entry", "description": "APIs for managing entries to the War Room" }, { "name": "Evidence", "description": "APIs for managing evidence entities" }, { "name": "Incident Fields", "description": "APIs for managing incident fields" }, { "name": "Incidents", "description": "APIs for managing incidents" }, { "name": "Indicators", "description": "APIs for managing indicators" }, { "name": "Integrations", "description": "APIs for managing integrations" }, { "name": "Investigations", "description": "APIs for managing playground investigations" }, { "name": "Playbooks", "description": "APIs for managing playbooks" }, { "name": "Reports", "description": "APIs for managing reports" }, { "name": "Scripts", "description": "APIs for managing scripts (automations)" }, { "name": "System Management", "description": "APIs for system management" }, { "name": "Widgets", "description": "APIs for managing widgets" } ], "paths": { "/apikeys/revoke/user/{username}": { "post": { "description": "Revoke API Key for user", "operationId": "revokeUserAPIKey", "parameters": [ { "name": "username", "in": "path", "description": "The username which the API keys assigned to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "200 for success" } }, "security": [ { "api_key": [] } ], "tags": [ "API Keys" ] } }, "/automation": { "post": { "summary": "Create or update automation", "description": "Create or update a given automation.", "operationId": "saveOrUpdateScript", "requestBody": { "$ref": "#/components/requestBodies/automationScriptFilterWrapper" }, "responses": { "200": { "description": "The saved automation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automationScriptResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Scripts" ] } }, "/automation/copy": { "post": { "summary": "Copy automation", "description": "Copy given automation", "operationId": "copyScript", "requestBody": { "$ref": "#/components/requestBodies/automationScriptFilterWrapper" }, "responses": { "200": { "description": "The saved automation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automationScriptResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Scripts" ] } }, "/automation/delete": { "post": { "summary": "Delete existing automation", "description": "Delete a given automation from the system.", "operationId": "deleteAutomationScript", "requestBody": { "$ref": "#/components/requestBodies/automationScriptFilterWrapper" }, "responses": { "200": { "description": "automation deleted" } }, "security": [ { "api_key": [] } ], "tags": [ "Scripts" ] } }, "/automation/import": { "post": { "summary": "Import an automation", "description": "Import an automation to Cortex XSOAR", "operationId": "importScript", "requestBody": { "$ref": "#/components/requestBodies/importScript" }, "responses": { "200": { "description": "The saved automation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AutomationScript" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Scripts" ] } }, "/automation/search": { "post": { "summary": "Search Automation (aka scripts)", "description": "Search Automation by filter", "operationId": "getAutomationScripts", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automationScriptFilter" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/automationScriptFilter" } } } }, "responses": { "200": { "description": "automationScriptResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automationScriptResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Scripts" ] } }, "/classifier/import": { "post": { "summary": "Import a classifier", "description": "Import a classifier to Cortex XSOAR", "operationId": "importClassifier", "requestBody": { "$ref": "#/components/requestBodies/importScript" }, "responses": { "200": { "description": "The saved classifiers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InstanceClassifier" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/contentpacks/installed/upload": { "post": { "summary": "Upload Pack", "description": "Upload Pack to the Server. Can be used to upload a Pack for an offline scenario or a Pack that hasn't been released.", "operationId": "uploadContentPacks", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "skipVerify": { "description": "If true will skip pack signature verification. Use when uploading a custom or dev pack.", "type": "string" }, "skipValidation": { "description": "if true will skip validation, use when migrate existing custom content to packs.", "type": "string" }, "file": { "description": "file", "type": "string" } } } } } }, "responses": { "200": { "description": "The pack was successfully uploaded" } }, "security": [ { "api_key": [] } ], "tags": [ "Content Packs" ] } }, "/dashboards/import": { "post": { "summary": "Import a dashboard", "description": "Import a dashboard to Cortex XSOAR", "operationId": "importDashboard", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "description": "The JSON file of the dashboard to import.", "type": "string" } } } } } }, "responses": { "200": { "description": "The saved dashboard", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Dashboards" ] } }, "/entry": { "post": { "summary": "Create new entry in existing investigation", "description": "API to create an entry (markdown format) in existing investigation\nBody example: {\"investigationId\":\"1234\",\"data\":\"entry content…\"}", "operationId": "investigationAddEntryHandler", "requestBody": { "$ref": "#/components/requestBodies/updateEntry" }, "responses": { "200": { "description": "Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entry" } } } }, "412": { "description": "In case of closed investigation" } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/entry/download/{entryid}": { "get": { "summary": "Download file", "description": "Download file from Cortex XSOAR by entry ID", "operationId": "downloadFile", "parameters": [ { "name": "entryid", "in": "path", "description": "Entry ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return the entry" } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/entry/execute/sync": { "post": { "summary": "Create new entry in existing investigation", "description": "API to create an entry (markdown format) in existing investigation\nBody example: {\"investigationId\":\"1234\",\"data\":\"entry content…\"}", "operationId": "investigationAddEntriesSync", "requestBody": { "$ref": "#/components/requestBodies/updateEntry" }, "responses": { "200": { "description": "An array of the children entries of the executed entry.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Entry" } } } } }, "412": { "description": "In case of closed investigation" } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/entry/exportArtifact": { "post": { "summary": "Export Artifact", "description": "Export an entry artifact", "operationId": "entryExportArtifact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadEntry" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DownloadEntry" } } } }, "responses": { "200": { "description": "created file name" } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/entry/formatted": { "post": { "summary": "Create new formatted entry in existing investigation", "description": "API to create a formatted entry (table/json/text/markdown/html) in existing investigation\nBody example: {\"investigationId\":\"1234\",\"format\":\"table/json/text/markdown/html\",\"contents\":\"entry content…\"}", "operationId": "investigationAddFormattedEntryHandler", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/uploadedEntry" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/uploadedEntry" } } } }, "responses": { "200": { "description": "Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entry" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/entry/note": { "post": { "summary": "Mark entry as note", "description": "API to mark entry as note, can be used also to remove the note\nBody example: {\"id\":1\\@1234\",\"version\":\"-1\",\"investigationId\":\"1234\",\"data\":\"true/false\"}", "operationId": "updateEntryNote", "requestBody": { "$ref": "#/components/requestBodies/updateEntry" }, "responses": { "200": { "description": "Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entry" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/entry/tags": { "post": { "summary": "Set entry tags", "description": "API to set entry tags\nBody example: {\"id\":\"1\\@1234\",\"version\":\"-1\",\"investigationId\":\"1234\",\"tags\":[\"tag1\",\"tag2\"]\"}", "operationId": "updateEntryTagsOp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateEntryTags" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/updateEntryTags" } } } }, "responses": { "200": { "description": "Entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entry" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Entry" ] } }, "/evidence": { "post": { "summary": "Save evidence", "description": "Save an evidence entity\nTo update evidence custom fields you should lowercase them and remove all spaces. For example: Scan IP -> scanip", "operationId": "saveEvidence", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Evidence" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Evidence" } } } }, "responses": { "200": { "description": "The new / updated Evidence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Evidence" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Evidence" ] } }, "/evidence/delete": { "post": { "summary": "delete evidence", "description": "Delete an evidence entity", "operationId": "deleteEvidenceOp", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteEvidence" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/deleteEvidence" } } } }, "responses": { "200": { "description": "Deleted evidence ID" } }, "security": [ { "api_key": [] } ], "tags": [ "Evidence" ] } }, "/evidence/search": { "post": { "summary": "Search evidence", "description": "Search for an evidence entutiy by filter", "operationId": "searchEvidence", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/evidencesFilterWrapper" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/evidencesFilterWrapper" } } } }, "responses": { "200": { "description": "EvidencesSearchResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvidencesSearchResponse" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Evidence" ] } }, "/health": { "get": { "summary": "Check if Cortex XSOAR server is available", "description": "Check if Cortex XSOAR server is available", "operationId": "healthHandler", "responses": { "200": { "description": "OK status", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "System Management" ] } }, "/health/containers": { "get": { "summary": "Get health containers", "description": "Gets info on the containers - amount of running, inactive and total containers", "operationId": "getContainers", "responses": { "200": { "description": "Gets info on the containers - amount of running, inactive and total containers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/containersInfo" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "System Management" ] } }, "/incident": { "post": { "summary": "Create single incident", "description": "Create or update incident according to JSON structure.\nTo update incident custom fields you should lowercase them and remove all spaces. For example: Scan IP -> scanip\nTo get the actual key name you can also go to Cortex XSOAR CLI and run /incident_add and look for the key that you would like to update\n\nUse the 'createInvestigation\\: true' to start the investigation process automatically. (by running a playbook based on incident type.)", "operationId": "createIncident", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIncidentRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateIncidentRequest" } } } }, "responses": { "200": { "description": "IncidentWrapper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentWrapper" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/batch": { "post": { "summary": "Update incidents in a batch", "description": "Update a batch of incidents.\nTo update incident custom fields you should lowercase them and remove all spaces. For example: Scan IP -> scanip\nTo get the actual key name you can also go to Cortex XSOAR CLI and run /incident_add and look for the key that you would like to update", "operationId": "createIncidentsBatch", "requestBody": { "$ref": "#/components/requestBodies/UpdateDataBatch" }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentSearchResponseWrapper" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/batch/exportToCsv": { "post": { "summary": "Batch export incidents to csv", "description": "Exports an incidents batch to CSV file (returns file ID)", "operationId": "exportIncidentsToCsvBatch", "requestBody": { "$ref": "#/components/requestBodies/UpdateDataBatch" }, "responses": { "200": { "description": "csv file name", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/batchClose": { "post": { "summary": "Batch close incidents", "description": "Closes an incidents batch\nTo update incident custom fields you should lowercase them and remove all spaces. For example: Scan IP -> scanip\nTo get the actual key name you can also go to Cortex XSOAR CLI and run /incident_add and look for the key that you would like to update", "operationId": "closeIncidentsBatch", "requestBody": { "$ref": "#/components/requestBodies/UpdateDataBatch" }, "responses": { "200": { "description": "IncidentSearchResponseWrapper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentSearchResponseWrapper" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/batchDelete": { "post": { "summary": "Batch delete incidents", "description": "Deletes an incidents batch", "operationId": "deleteIncidentsBatch", "requestBody": { "$ref": "#/components/requestBodies/UpdateDataBatch" }, "responses": { "200": { "description": "IncidentSearchResponseWrapper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentSearchResponseWrapper" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/csv/{id}": { "get": { "summary": "Get incident as CSV", "description": "Get an incident CSV file that was exported, by ID", "operationId": "getIncidentAsCsv", "parameters": [ { "name": "id", "in": "path", "description": "CSV file to fetch (returned from batch export to csv call)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return Csv file" } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/json": { "post": { "summary": "Create incident from JSON", "description": "Create single incident from raw JSON, builds incident according to default mapping", "operationId": "createIncidentJson", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentWrapper" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incident/upload/{id}": { "post": { "description": "Add file attachement to an incidents", "operationId": "incidentFileUpload", "parameters": [ { "name": "id", "in": "path", "description": "Incident id to update", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileName": { "description": "file name", "type": "string" }, "fileComment": { "description": "file comment", "type": "string" }, "field": { "description": "field name to hold the attachment details. If not specified, `attachment` will be used.", "type": "string" }, "showMediaFile": { "description": "show media file", "type": "boolean" }, "last": { "description": "If set to true will create an investigation. Used for uploading after creating incident.", "type": "boolean" }, "file": { "description": "file", "type": "string" } } } } } }, "responses": { "200": { "description": "IncidentWrapper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentWrapper" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incidentfield/tags/reset/{id}": { "post": { "summary": "Set tags field", "description": "Sets the select values of a specific tags field. The values passed to the route override the existing select\nvalues of the field. To reset the select values pass an empty array.", "operationId": "setTagsField", "parameters": [ { "name": "id", "in": "path", "description": "The machine name of the field prefixed with the type. For example indicator_tags or incident_dbotmirrortags", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagsFieldValues" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/tagsFieldValues" } } }, "description": "The new select values of the field", "required": true }, "responses": { "200": { "description": "empty" } }, "security": [ { "api_key": [] } ], "tags": [ "Incident Fields" ] } }, "/incidentfields/associatedTypes/{type}": { "get": { "summary": "Get all incident fields associated with incident type", "description": "Get all incident fields associated with incident type", "operationId": "getIncidentsFieldsByIncidentType", "parameters": [ { "name": "type", "in": "path", "description": "the name (case sensitive) of the incident type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns a list of incident fields associated with the incident type", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentField" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incident Fields" ] } }, "/incidentfields/import": { "post": { "summary": "Import an incident field", "description": "Import an incident field to Cortex XSOAR", "operationId": "importIncidentFields", "requestBody": { "$ref": "#/components/requestBodies/importScript" }, "responses": { "200": { "description": "The saved incident field", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidentFieldsWithErrors" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incident Fields" ] } }, "/incidents/search": { "post": { "summary": "Search incidents by filter", "description": "Search incidents across all indices. You can filter by multiple options.\r\n\r\n**Note:** You cannot paginate results in a multi-tenant environment.", "operationId": "searchIncidents", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchIncidentsData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SearchIncidentsData" } } }, "required": true }, "responses": { "200": { "description": "incidentSearchResponse", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Incident" } }, "total": { "type": "integer" } } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incidenttype": { "post": { "summary": "Create new Incident Type", "description": "API to create new Incident Type", "operationId": "createOrUpdateIncidentType", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentType" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IncidentType" } } } }, "responses": { "200": { "description": "IncidentType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncidentType" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/incidenttypes/import": { "post": { "summary": "Import an incident type", "description": "Import an incident type to Cortex XSOAR.", "operationId": "importIncidentTypesHandler", "requestBody": { "$ref": "#/components/requestBodies/importScript" }, "responses": { "200": { "description": "The saved incident type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incidentTypesWithErrors" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Incidents" ] } }, "/indicator/create": { "post": { "summary": "Create Indicator", "description": "Create an indicator entity\nTo update indicator custom fields you should lowercase them and remove all spaces. For example: Scan IP -> scanip", "operationId": "indicatorsCreate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/indicatorContext" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/indicatorContext" } } } }, "responses": { "200": { "description": "IocObject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IocObject" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicator/edit": { "post": { "summary": "Edit Indicator", "description": "Edit an indicator entity\nTo update indicator custom fields you should lowercase them and remove all spaces. For example: Scan IP -> scanip", "operationId": "indicatorsEdit", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IocObject" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IocObject" } } } }, "responses": { "200": { "description": "IocObject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IocObject" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicator/whitelist": { "post": { "summary": "Whitelists or deletes Indicator", "description": "Whitelists or deletes an indicator entity\nIn order to delete an indicator and not whitelist, set doNotWhitelist boolean field to true", "operationId": "indicatorWhitelist", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateIndicatorReputationData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/updateIndicatorReputationData" } } } }, "responses": { "200": { "description": "UpdateResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/batch/export/stix": { "post": { "summary": "Batch export indicators to STIX", "description": "Exports an indicators batch to STIX file (returns file ID)", "operationId": "exportIndicatorsToStixBatch", "requestBody": { "$ref": "#/components/requestBodies/genericIndicatorUpdateBatch" }, "responses": { "200": { "description": "STIX file name", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/batch/exportToCsv": { "post": { "summary": "Batch export indicators to csv", "description": "Exports an indicators batch to CSV file (returns file ID)", "operationId": "exportIndicatorsToCsvBatch", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericIndicatorUpdateBatch" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/genericIndicatorUpdateBatch" } } }, "description": "Required parameters from `genericIndicatorUpdateBatch`: `columns`,\n`filter`. You should also include either `all` or `ids`\n" }, "responses": { "200": { "description": "csv file name", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/batchDelete": { "post": { "summary": "Batch whitelist or delete indicators", "description": "Batch whitelist or delete indicators entities\nIn order to delete indicators and not whitelist, set doNotWhitelist boolean field to true", "operationId": "deleteIndicatorsBatch", "requestBody": { "$ref": "#/components/requestBodies/genericIndicatorUpdateBatch" }, "responses": { "200": { "description": "UpdateResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateResponse" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/csv/{id}": { "get": { "summary": "Get indicators as CSV", "description": "Get an indicators CSV file that was exported, by ID", "operationId": "getIndicatorsAsCsv", "parameters": [ { "name": "id", "in": "path", "description": "CSV file to fetch (returned from batch export to csv call)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return Csv file" } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/feed/json": { "post": { "summary": "Create feed indicators from JSON", "description": "Create indicators from raw JSON (similar to ingesting from a feed). Builds indicators according to the specified feed classifier,\nor uses the default one if not specified.\nIndicator properties (all optional except for value): **value** (string, required) | **type** (string) | **score** (number, 0-3,\ndefault `0`, where `0` means None, `1` Good, `2` Suspicious, and `3` Bad) | **sourceBrand** (string, default `\"External\"`) | **sourceInstance**\n(string, default `\"External\"`) | **reliability** (string, one of `\"A - Completely reliable\"`, `\"B - Usually reliable\"`, `\"C - Fairly\nreliable\"`, `\"D - Not usually reliable\"`, `\"E - Unreliable\"`, `\"F - Reliability cannot be judged\"`) | **expirationPolicy** (string,\none of `\"never\"`, `\"interval\"`, `\"indicatorType\"`) | **expirationInterval** (number, in minutes)", "operationId": "createFeedIndicatorsJson", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeedIndicatorsRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FeedIndicatorsRequest" } } }, "required": true }, "responses": { "201": { "description": "Indicators created" } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/search": { "post": { "summary": "Search indicators", "description": "Search indicators by filter", "operationId": "indicatorsSearch", "requestBody": { "$ref": "#/components/requestBodies/IndicatorFilter" }, "responses": { "200": { "description": "indicatorResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndicatorResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/stix/v2/{id}": { "get": { "summary": "Get indicators as STIX V2", "description": "Get an indicators STIX V2 file that was exported, by ID", "operationId": "getIndicatorsAsSTIX", "parameters": [ { "name": "id", "in": "path", "description": "STIX V2 file to fetch (returned from batch export to STIX call)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return STIX V2 file" } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/timeline/delete": { "post": { "summary": "Delete indicators timeline", "description": "Delete indicators timeline by filter", "operationId": "indicatorsTimelineDelete", "requestBody": { "$ref": "#/components/requestBodies/IndicatorFilter" }, "responses": { "200": { "description": "IndicatorEditBulkResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndicatorEditBulkResponse" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/upload": { "post": { "summary": "Create indicators", "description": "Create indicators from a file", "operationId": "indicatorsCreateBatch", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "fileName": { "description": "file name", "type": "string" }, "file": { "description": "file", "type": "string" } } } } } }, "responses": { "200": { "description": "IocObjects", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IocObjects" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/indicators/whitelist/update": { "post": { "summary": "Create whitelisted", "description": "Create or update excluded indicators list", "operationId": "createOrUpdateWhitelisted", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhitelistedIndicator" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WhitelistedIndicator" } } }, "required": true }, "responses": { "200": { "description": "WhitelistedIndicator", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WhitelistedIndicator" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Indicators" ] } }, "/inv-playbook/task/add/{investigationId}": { "post": { "summary": "Add ad-hoc task", "description": "Add an ad-hoc task to a running playbook", "operationId": "addAdHocTask", "parameters": [ { "name": "investigationId", "in": "path", "description": "investigation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/InvPlaybookTaskData" }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/assign": { "post": { "summary": "Assign task", "description": "Assign a task to an owner", "operationId": "taskAssign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invPlaybookAssignee" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/invPlaybookAssignee" } } } }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/complete": { "post": { "summary": "[Deprecated] Complete a task", "description": "Complete a task with a file attachment\nDeprecated - use \"/v2/inv-playbook/task/complete\"", "operationId": "completeTask", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "investigationId": { "description": "investigation ID", "type": "string" }, "fileName": { "description": "file name", "type": "string" }, "fileComment": { "description": "file comment", "type": "string" }, "taskId": { "description": "Task Id", "type": "string" }, "taskInput": { "description": "task input", "type": "string" }, "version": { "description": "Version", "type": "string" }, "file": { "description": "file", "type": "string" } } } } } }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/complete/simple": { "post": { "summary": "Complete task simple (no file)", "description": "Complete a task without a file attachment", "operationId": "simpleCompleteTask", "requestBody": { "$ref": "#/components/requestBodies/invTaskInfo" }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/delete/{investigationId}/{invPBTaskId}": { "post": { "summary": "Delete ad-hoc task", "description": "Delete an ad-hoc task from a running playbook", "operationId": "deleteAdHocTask", "parameters": [ { "name": "invPBTaskId", "in": "path", "description": "ad-hoc task ID", "required": true, "schema": { "type": "string" } }, { "name": "investigationId", "in": "path", "description": "investigation ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/due": { "post": { "summary": "Set task due date", "description": "Set the task due date", "operationId": "taskSetDue", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invPlaybookDue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/invPlaybookDue" } } } }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/edit/{investigationId}": { "post": { "summary": "Edit ad-hoc task", "description": "Edit an ad-hoc task in a running playbook", "operationId": "editAdHocTask", "parameters": [ { "name": "investigationId", "in": "path", "description": "investigation ID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/InvPlaybookTaskData" }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/note/add": { "post": { "summary": "Task add comment", "description": "Add comment to a task", "operationId": "taskAddComment", "requestBody": { "$ref": "#/components/requestBodies/invTaskInfo" }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/inv-playbook/task/uncomplete": { "post": { "summary": "Un complete a task", "description": "Reopen a closed task and change the status to uncomplete", "operationId": "taskUnComplete", "requestBody": { "$ref": "#/components/requestBodies/invTaskInfo" }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/investigations/search": { "post": { "summary": "Search investigations by filter", "description": "This will search investigations across all indices\nYou can filter by multiple options", "operationId": "searchInvestigations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchInvestigationsData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SearchInvestigationsData" } } } }, "responses": { "200": { "description": "investigationSearchResponse", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationSearchResponse" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Investigations" ] } }, "/logout/everyone": { "post": { "summary": "Sign out all open users sessions", "description": "Sign out all open users sessions", "operationId": "logoutEveryoneHandler", "responses": { "204": { "description": "no content", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Authentication" ] } }, "/logout/myself": { "post": { "summary": "Sign out all my open sessions", "description": "Sign out all my open sessions", "operationId": "logoutMyselfHandler", "responses": { "204": { "description": "no content", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Authentication" ] } }, "/logout/myself/other": { "post": { "summary": "Sign out all my other open sessions", "description": "Sign out all my other open sessions", "operationId": "logoutMyselfOtherSessionsHandler", "responses": { "204": { "description": "no content", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Authentication" ] } }, "/logout/user/{username}": { "post": { "summary": "Sign out all sessions of the provided username", "description": "Sign out all sessions of the provided username", "operationId": "logoutUserSessionsHandler", "parameters": [ { "name": "username", "in": "path", "description": "Username to logout", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "no content", "content": { "application/json": { "schema": { "type": "string" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Authentication" ] } }, "/playbook/save/yaml": { "post": { "summary": "Import and override playbook", "description": "Import and override playbook in Cortex XSOAR", "operationId": "overridePlaybookYaml", "requestBody": { "$ref": "#/components/requestBodies/importScript" }, "responses": { "200": { "description": "The saved playbook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/playbookWithWarnings" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/report/{id}/latest": { "get": { "summary": "Get latest report by ID", "description": "Get the latest report by its ID.\r\n\r\n**Note:** To get the report, it must be a scheduled report with recipients.", "operationId": "downloadLatestReport", "parameters": [ { "name": "id", "in": "path", "description": "the ID of the report to get", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a report file" } }, "security": [ { "api_key": [] } ], "tags": [ "Reports" ] } }, "/report/{id}/{requestId}/execute": { "post": { "summary": "Execute report", "description": "Execute a new report", "operationId": "executeReport", "parameters": [ { "name": "requestId", "in": "path", "description": "the ID to register the request under", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "description": "the ID of the report to get", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Request registered" } }, "security": [ { "api_key": [] } ], "tags": [ "Reports" ] } }, "/reports": { "get": { "summary": "Get all reports", "description": "Get all of the reports", "operationId": "getAllReports", "responses": { "200": { "description": "Return array of reports", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Reports" ] } }, "/reports/upload": { "post": { "summary": "Upload a report to Cortex XSOAR", "description": "Upload a report to Cortex XSOAR", "operationId": "uploadReport", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "description": "The report file to upload", "type": "string" } } } } } }, "responses": { "200": { "description": "A list of all the reports in the instance", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Reports" ] } }, "/reports/{id}": { "get": { "summary": "Get report by ID", "description": "Get a report by its ID", "operationId": "getReportByID", "parameters": [ { "name": "id", "in": "path", "description": "the ID of the report to get", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return a report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Reports" ] } }, "/settings/audits": { "post": { "summary": "Get Audits", "description": "Get audits by filter", "operationId": "getAudits", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericStringDateFilter" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/GenericStringDateFilter" } } } }, "responses": { "200": { "description": "auditResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/auditResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Audit Log" ] } }, "/settings/docker-images": { "get": { "summary": "Get Docker Images", "description": "Get list of all available docker image names", "operationId": "getDockerImages", "responses": { "200": { "description": "DockerImagesResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DockerImagesResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "System Management" ] }, "post": { "summary": "Create Image", "description": "Create an image with a given list of dependencies", "operationId": "createDockerImage", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDockerImage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NewDockerImage" } } } }, "responses": { "200": { "description": "NewDockerImageResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDockerImageResult" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "System Management" ] } }, "/settings/integration-conf/upload": { "post": { "summary": "Upload an integration", "description": "Upload an integration to Cortex XSOAR", "operationId": "integrationUpload", "requestBody": { "$ref": "#/components/requestBodies/importScript" }, "responses": { "200": { "description": "The saved configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModuleConfiguration" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Integrations" ] } }, "/statistics/application/roi": { "delete": { "summary": "Reset ROI widget", "description": "Reset ROI widget", "operationId": "resetROIWidget", "responses": { "200": { "description": "ROI widget has been reset" } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] } }, "/statistics/dashboards/query": { "post": { "summary": "[Deprecated] Get Dashboard Statistics", "description": "Get a given dashboard statistics result.\nDeprecated - use \"/v2/statistics/dashboards/query", "operationId": "GetStatsForDashboardOldFormat", "responses": { "200": { "description": "Return an array of stats results for each widget cell in dashboard.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatsQueryResponse" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Dashboards" ] } }, "/statistics/widgets/query": { "post": { "summary": "[Deprecated] Get Widget Statistics", "description": "Get a given widget object statistics result.\nNote: This route has many return types based on the widget type and data. Each 200X represent a 200 OK request of specific widget type and data\n\nDeprecated - use \"/v2/statistics/widgets/query", "operationId": "GetStatsForWidgetOldFormat", "responses": { "200": { "description": "Response differ according to the widget type\n - Incident data type of a \"table\" or \"list\" widget returns incidentSearchResponse\n total:\n type: integer\n data:\n type: array\n items:\n \"$ref\": \"#/definitions/Incident\"\n - Indicators data type of a \"table\" or \"list\" widget returns IoCsResponse\n total:\n type: integer\n data:\n type: array\n items:\n \"$ref\": \"#/definitions/IocObject\"\n - Number widget returns a simple number\n type: integer\n - Trend widget returns a trend object\n \"$ref\": \"#/definitions/StatsTrendsResponse\"\n - Text widget returns a text object, describing the final text and the placeholders values.\n \"$ref\": \"#/definitions/StatsTextResponse\"\n - A chart data array by groups. When requesting a date, the key is the date string, according to the specified time frame. Empty groups (dates) are also returned.\n type: array\n items:\n \"$ref\": \"#/definitions/Group\"", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] } }, "/v2/inv-playbook/task/complete": { "post": { "summary": "Complete a task", "description": "Complete a task with command and multiple file attachments", "operationId": "completeTaskV2", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "investigationId": { "description": "investigation ID", "type": "string" }, "taskId": { "description": "Task Id", "type": "string" }, "taskComment": { "description": "Task comment or command to run", "type": "string" }, "taskInput": { "description": "Task input", "type": "string" }, "version": { "description": "Version", "type": "string" }, "file": { "description": "Files to attach to the task", "type": "string" }, "fileNames": { "description": "file names separated by %###% (only if files provided)", "type": "string" }, "fileComments": { "description": "file comment separated by %###% (only if files provided)", "type": "string" } } } } } }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/v2/inv-playbook/task/form/submit": { "post": { "summary": "Complete a task", "description": "Submit a data collection task with given answers and multiple file attachments", "operationId": "submitTaskForm", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "investigationId": { "description": "investigation ID", "type": "string" }, "taskId": { "description": "Task Id", "type": "string" }, "answers": { "description": "the answers to the task form. Answers are keyed by numerical question id", "type": "string" }, "file": { "description": "Files to attach to the task", "type": "string" } } } } } }, "responses": { "200": { "description": "InvestigationPlaybook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestigationPlaybook" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Playbooks" ] } }, "/v2/statistics/dashboards/query": { "post": { "summary": "Get Dashboard Statistics", "description": "Get a given dashboard statistics result.", "operationId": "GetStatsForDashboard", "responses": { "200": { "description": "Return an array of stats results for each widget cell in dashboard.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StatsQueryResponse" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Dashboards" ] } }, "/v2/statistics/widgets/query": { "post": { "summary": "Get Widget Statistics", "description": "Get the statistics for the specified widget.\n**Note:** This endpoint has many return types depending on the widget type and data. Each 200X represents a 200 OK request of specific widget type and data.", "operationId": "GetStatsForWidget", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dataType": { "type": "string" }, "widgetType": { "type": "string" }, "query": { "type": "string" }, "dateRange": { "type": "object", "properties": { "fromDate": { "type": "string" }, "toDate": { "type": "string" } } }, "params": { "type": "object", "properties": { "groupBy": { "type": "array", "items": { "type": "string" } } } }, "category": { "type": "string" } } } }, "application/xml": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dataType": { "type": "string" }, "widgetType": { "type": "string" }, "query": { "type": "string" }, "dateRange": { "type": "object", "properties": { "fromDate": { "type": "string" }, "toDate": { "type": "string" } } }, "params": { "type": "object", "properties": { "groupBy": { "type": "array", "items": { "type": "string" } } } }, "category": { "type": "string" } } } } } }, "responses": { "200": { "description": "Response differ according to the widget type\n - Incident data type of a \"table\" or \"list\" widget returns incidentSearchResponse\n total:\n type: integer\n data:\n type: array\n items:\n \"$ref\": \"#/definitions/Incident\"\n - Indicators data type of a \"table\" or \"list\" widget returns IoCsResponse\n total:\n type: integer\n data:\n type: array\n items:\n \"$ref\": \"#/definitions/IocObject\"\n - Number widget returns a simple number\n type: integer\n - Trend widget returns a trend object\n \"$ref\": \"#/definitions/StatsTrendsResponse\"\n - Text widget returns a text object, describing the final text and the placeholders values.\n \"$ref\": \"#/definitions/StatsTextResponse\"\n - Line chart widget or Column chart widget returns StatsResponseWithReferenceLine\n \"$ref\": \"#/definitions/StatsResponseWithReferenceLine\"\n - A chart data array by groups. When requesting a date, the key is the date string, according to the specified time frame. Empty groups (dates) are also returned.\n type: array\n items:\n \"$ref\": \"#/definitions/Group\"", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] } }, "/widgets": { "get": { "description": "Get all widgets", "operationId": "getAllWidgets", "responses": { "200": { "description": "Return all the widgets in the system.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Widget" } } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] }, "post": { "summary": "Add or update a widget", "description": "Add or update a given widget based on Id.", "operationId": "saveWidget", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Widget" } } } }, "responses": { "200": { "description": "The saved widget newest version.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] } }, "/widgets/import": { "post": { "summary": "Import a widget", "description": "Import a widget to the system, ignoring ID or version, used to import new widgets.", "operationId": "importWidget", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "description": "The JSON file of the widget to import.", "type": "string" } } } } } }, "responses": { "200": { "description": "The saved widget", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] } }, "/widgets/{id}": { "get": { "summary": "Get widget by ID", "description": "Get a widget object by a given ID.", "operationId": "getWidget", "parameters": [ { "name": "id", "in": "path", "description": "The ID of widget to get.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Return the widget if found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Widget" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] }, "delete": { "summary": "Remove existing widget", "description": "Remove a given widget Id from the system.", "operationId": "deleteWidget", "parameters": [ { "name": "id", "in": "path", "description": "Widget id to remove (returned from widget save or widgets get)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "widget deleted" } }, "security": [ { "api_key": [] } ], "tags": [ "Widgets" ] } }, "/workers/status": { "get": { "summary": "Get workers status", "description": "Get workers status", "operationId": "workersStatusHandler", "responses": { "200": { "description": "Workers status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Info" } } } } }, "security": [ { "api_key": [] } ], "tags": [ "System Management" ] } } }, "components": { "requestBodies": { "invTaskInfo": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invTaskInfo" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/invTaskInfo" } } } }, "automationScriptFilterWrapper": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/automationScriptFilterWrapper" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/automationScriptFilterWrapper" } } } }, "InvPlaybookTaskData": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvPlaybookTaskData" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InvPlaybookTaskData" } } } }, "updateEntry": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateEntry" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/updateEntry" } } } }, "importScript": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "description": "file", "type": "string" } } } } } }, "UpdateDataBatch": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataBatch" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateDataBatch" } } } }, "genericIndicatorUpdateBatch": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/genericIndicatorUpdateBatch" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/genericIndicatorUpdateBatch" } } } }, "IndicatorFilter": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndicatorFilter" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/IndicatorFilter" } } } } }, "securitySchemes": { "api_key": { "type": "apiKey", "name": "Authorization", "in": "header" } }, "schemas": { "automationScriptFilterWrapper": { "type": "object", "title": "automationScriptFilterWrapper ...", "properties": { "filter": { "$ref": "#/components/schemas/GenericStringFilter" }, "savePassword": { "type": "boolean", "x-go-name": "StorePassword" }, "script": { "$ref": "#/components/schemas/AutomationScript" } }, "x-go-package": "github.com/demisto/server/web" }, "GenericStringFilter": { "type": "object", "description": "GenericStringFilter is a general filter that will fetch entities using the Query value", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "query": { "type": "string", "x-go-name": "Query" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Order": { "type": "object", "description": "Order struct holds a sort field and the direction of sorting", "properties": { "asc": { "type": "boolean", "x-go-name": "Asc" }, "field": { "type": "string", "x-go-name": "Field" }, "fieldType": { "type": "string", "x-go-name": "FieldType" } }, "x-go-package": "github.com/demisto/server/domain" }, "AutomationScript": { "type": "object", "description": "AutomationScript represents a script that will run on the system", "properties": { "MainEngineInfo": { "$ref": "#/components/schemas/EngineInfo" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/Argument" }, "x-go-name": "Args" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "comment": { "type": "string", "x-go-name": "Comment" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "contextKeys": { "type": "array", "items": { "type": "string" }, "x-go-name": "ContextKeys" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "dependsOn": { "type": "object", "description": "This fields indicates which commands this script depends on", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "DependsOn" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "detached": { "type": "boolean", "x-go-name": "Detached" }, "dockerImage": { "type": "string", "x-go-name": "DockerImage" }, "enabled": { "type": "boolean", "x-go-name": "Enabled" }, "engine": { "type": "string", "description": "Engine that will run the script", "x-go-name": "Engine" }, "engineGroup": { "type": "string", "description": "EngineGroup that will run the script", "x-go-name": "EngineGroup" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "important": { "type": "array", "items": { "$ref": "#/components/schemas/Important" }, "x-go-name": "Important" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Output" }, "x-go-name": "Outputs" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "polling": { "type": "boolean", "x-go-name": "Polling" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "private": { "type": "boolean", "x-go-name": "Private" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "pswd": { "type": "string", "x-go-name": "Password" }, "rawTags": { "type": "array", "items": { "type": "string" }, "x-go-name": "RawTags" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "runAs": { "type": "string", "x-go-name": "RunAs" }, "runOnce": { "type": "boolean", "x-go-name": "RunOnce" }, "script": { "type": "string", "x-go-name": "Script" }, "scriptTarget": { "$ref": "#/components/schemas/ScriptTarget" }, "searchableName": { "type": "string", "x-go-name": "DoNotUseName" }, "sensitive": { "type": "boolean", "x-go-name": "Sensitive" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourceScripID": { "type": "string", "x-go-name": "SourceScripID" }, "subtype": { "$ref": "#/components/schemas/ScriptSubType" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "timeout": { "$ref": "#/components/schemas/Duration" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "type": { "$ref": "#/components/schemas/ScriptType" }, "user": { "type": "string", "x-go-name": "User" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "visualScript": { "type": "string", "x-go-name": "VisualScript" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "EngineInfo": { "type": "object", "title": "EngineInfo ...", "properties": { "engine": { "type": "string", "description": "Engine that will run the script", "x-go-name": "Engine" }, "engineGroup": { "type": "string", "description": "EngineGroup that will run the script", "x-go-name": "EngineGroup" } }, "x-go-package": "github.com/demisto/server/domain" }, "Argument": { "type": "object", "description": "Argument to a module command", "properties": { "auto": { "type": "string", "x-go-name": "Auto" }, "default": { "type": "boolean", "x-go-name": "Default" }, "defaultValue": { "type": "string", "x-go-name": "DefaultValue" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "description": { "type": "string", "x-go-name": "Description" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "isArray": { "type": "boolean", "x-go-name": "IsArray" }, "name": { "type": "string", "x-go-name": "Name" }, "predefined": { "type": "array", "items": { "type": "string" }, "x-go-name": "Predefined" }, "required": { "type": "boolean", "x-go-name": "Required" }, "secret": { "type": "boolean", "x-go-name": "Secret" }, "type": { "$ref": "#/components/schemas/ArgumentType" } }, "x-go-package": "github.com/demisto/server/domain" }, "ArgumentType": { "type": "string", "title": "ArgumentType ...", "x-go-package": "github.com/demisto/server/domain" }, "Version": { "type": "object", "title": "Version represents a version.", "properties": { "Digits": { "type": "array", "description": "WARNING: when adding new attributes or changing the names\nof the existing ones, remember to add support in UnmarshalJSON\nfor items that were exported by msgpack.", "items": { "type": "integer", "format": "int64" } }, "Label": { "type": "string" } }, "x-go-package": "github.com/demisto/server/domain" }, "Important": { "type": "object", "description": "Important The important outputs of a given command", "properties": { "contextPath": { "type": "string", "x-go-name": "ContextPath" }, "description": { "type": "string", "description": "Description is either a string or a map from string to interface", "x-go-name": "Description" }, "related": { "type": "string", "description": "To what other context path this output is related", "x-go-name": "Related" } }, "x-go-package": "github.com/demisto/server/domain" }, "Output": { "type": "object", "description": "Output of a module command", "properties": { "contentPath": { "type": "string", "x-go-name": "ContentPath" }, "contextPath": { "type": "string", "x-go-name": "ContextPath" }, "description": { "type": "object", "description": "Description is either a string or a map from string to interface", "x-go-name": "Description" }, "type": { "$ref": "#/components/schemas/OutputType" } }, "x-go-package": "github.com/demisto/server/domain" }, "OutputType": { "type": "string", "title": "OutputType ...", "x-go-package": "github.com/demisto/server/domain" }, "ScriptTarget": { "type": "integer", "description": "ScriptTarget represents the module where this script should run", "format": "int64", "x-go-package": "github.com/demisto/server/domain" }, "ScriptSubType": { "type": "string", "description": "ScriptSubType holds the script type version", "x-go-package": "github.com/demisto/server/domain" }, "Duration": { "type": "integer", "description": "A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.", "format": "int64", "x-go-package": "time" }, "ScriptType": { "type": "string", "description": "ScriptType holds the type of a script", "x-go-package": "github.com/demisto/server/domain" }, "automationScriptResult": { "type": "object", "title": "automationScriptResult ...", "properties": { "pythonEnabled": { "type": "boolean", "x-go-name": "PythonEnabled" }, "scripts": { "type": "array", "items": { "$ref": "#/components/schemas/ScriptAPI" }, "x-go-name": "Scripts" }, "selectedScript": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "SelectedScript" }, "suggestions": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" } }, "x-go-package": "github.com/demisto/server/web" }, "ScriptAPI": { "type": "object", "title": "ScriptAPI ...", "properties": { "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/Argument" }, "x-go-name": "Args" }, "comment": { "type": "string", "x-go-name": "Comment" }, "contextKeys": { "type": "array", "items": { "type": "string" }, "x-go-name": "ContextKeys" }, "dependsOn": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "DependsOn" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "detached": { "type": "boolean", "x-go-name": "Detached" }, "dockerImage": { "type": "string", "x-go-name": "DockerImage" }, "enabled": { "type": "boolean", "x-go-name": "Enabled" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "id": { "type": "string", "x-go-name": "ID" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Output" }, "x-go-name": "Outputs" }, "permitted": { "type": "boolean", "x-go-name": "Permitted" }, "polling": { "type": "boolean", "x-go-name": "Polling" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "roles": { "type": "array", "items": { "type": "string" }, "x-go-name": "Roles" }, "runAs": { "type": "string", "x-go-name": "RunAs" }, "scriptTarget": { "$ref": "#/components/schemas/ScriptTarget" }, "system": { "type": "boolean", "x-go-name": "System" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "type": { "$ref": "#/components/schemas/ScriptType" }, "user": { "type": "string", "x-go-name": "User" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Version" } }, "x-go-package": "github.com/demisto/server/services/automation" }, "automationScriptFilter": { "type": "object", "description": "automationScriptFilter is a general filter that fetches entities using a query string query using the Query value", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "query": { "type": "string", "x-go-name": "Query" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "stripContext": { "type": "boolean", "x-go-name": "StripContext" } }, "x-go-package": "github.com/demisto/server/web" }, "InstanceClassifier": { "type": "object", "description": "InstanceClassifier - classifies an incident from a specific brand", "properties": { "brands": { "type": "array", "items": { "type": "string" }, "x-go-name": "Brands" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "defaultIncidentType": { "type": "string", "x-go-name": "DefaultIncidentType" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "description": { "type": "string", "x-go-name": "Description" }, "feed": { "type": "boolean", "x-go-name": "Feed" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "incidentSamples": { "$ref": "#/components/schemas/Incidents" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "indicatorSamples": { "$ref": "#/components/schemas/FeedIndicators" }, "instanceIds": { "type": "array", "items": { "type": "string" }, "x-go-name": "InstanceIDs" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "keyTypeMap": { "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "KeyTypeMap" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "logicalVersion": { "type": "integer", "format": "int64", "x-go-name": "LogicalVersion" }, "mapping": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Mapper" }, "x-go-name": "Mapping" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "nameRaw": { "type": "string", "x-go-name": "NameRaw" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourceClassifierId": { "type": "string", "x-go-name": "SourceClassifierID" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "transformer": { "$ref": "#/components/schemas/AdvanceArg" }, "type": { "$ref": "#/components/schemas/MapperType" }, "unclassifiedCases": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/UnclassifiedCases" }, "x-go-name": "UnclassifiedCases" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "Incidents": { "description": "Incidents is a list of incident entities" }, "FeedIndicators": { "type": "array", "title": "FeedIndicators ...", "items": { "$ref": "#/components/schemas/FeedIndicator" }, "x-go-package": "github.com/demisto/server/domain" }, "FeedIndicator": { "type": "object", "title": "FeedIndicator ...", "properties": { "ExpirationSource": { "$ref": "#/components/schemas/ExpirationSource" }, "bypassExclusionList": { "type": "boolean", "x-go-name": "ShouldBypassExclusionList" }, "classifierId": { "type": "string", "x-go-name": "ClassifierID" }, "classifierVersion": { "type": "integer", "format": "int64", "x-go-name": "ClassifierVersion" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/FeedIndicatorComment" }, "x-go-name": "Comments" }, "expirationInterval": { "type": "integer", "format": "int64", "x-go-name": "ExpirationInterval" }, "expirationPolicy": { "$ref": "#/components/schemas/ExpirationPolicy" }, "fetchTime": { "type": "string", "format": "date-time", "x-go-name": "FetchTime" }, "fields": { "$ref": "#/components/schemas/CustomFields" }, "isEnrichment": { "type": "boolean", "x-go-name": "IsEnrichment" }, "mapperId": { "type": "string", "x-go-name": "MapperID" }, "mapperVersion": { "type": "integer", "format": "int64", "x-go-name": "MapperVersion" }, "modifiedTime": { "type": "string", "format": "date-time", "x-go-name": "ModifiedTime" }, "moduleId": { "type": "string", "x-go-name": "ModuleID" }, "rawJSON": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "RawJSON" }, "relationships": { "$ref": "#/components/schemas/RelationshipsAPI" }, "reliability": { "$ref": "#/components/schemas/Reliability" }, "score": { "type": "integer", "format": "int64", "x-go-name": "Score" }, "sourceBrand": { "type": "string", "x-go-name": "Brand" }, "sourceInstance": { "type": "string", "x-go-name": "Instance" }, "timestamp": { "type": "string", "format": "date-time", "x-go-name": "TimeStamp" }, "type": { "type": "string", "x-go-name": "Type" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "github.com/demisto/server/domain" }, "ExpirationSource": { "type": "object", "title": "ExpirationSource ..\t.", "properties": { "brand": { "type": "string", "x-go-name": "Brand" }, "expirationInterval": { "type": "integer", "format": "int64", "x-go-name": "ExpirationInterval" }, "expirationPolicy": { "$ref": "#/components/schemas/ExpirationPolicy" }, "instance": { "type": "string", "x-go-name": "Instance" }, "moduleId": { "type": "string", "x-go-name": "ModuleID" }, "setTime": { "type": "string", "format": "date-time", "x-go-name": "SetTime" }, "source": { "$ref": "#/components/schemas/ExpirationSettingsSource" }, "user": { "type": "string", "x-go-name": "User" } }, "x-go-package": "github.com/demisto/server/domain" }, "ExpirationPolicy": { "type": "string", "title": "ExpirationPolicy ...", "x-go-package": "github.com/demisto/server/domain" }, "ExpirationSettingsSource": { "type": "string", "title": "ExpirationSettingsSource ...", "x-go-package": "github.com/demisto/server/domain" }, "FeedIndicatorComment": { "type": "object", "title": "FeedIndicatorComment ...", "properties": { "content": { "type": "string", "x-go-name": "Content" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "id": { "type": "string", "x-go-name": "ID" }, "user": { "type": "string", "x-go-name": "User" } }, "x-go-package": "github.com/demisto/server/domain" }, "CustomFields": { "type": "object", "title": "CustomFields ...", "description": "The keys should be the field's display name all lower and without spaces. For example: Scan IP -> scanip\nTo get the actual key name you can also go to Cortex XSOAR CLI and run /incident_add and look for the key that you would like to update", "additionalProperties": { "type": "object" }, "x-go-package": "github.com/demisto/server/domain" }, "RelationshipsAPI": { "type": "array", "title": "RelationshipsAPI ...", "items": { "$ref": "#/components/schemas/RelationshipAPI" }, "x-go-package": "github.com/demisto/server/domain" }, "RelationshipAPI": { "type": "object", "title": "RelationshipAPI ...", "properties": { "brand": { "type": "string", "x-go-name": "Brand" }, "entityA": { "type": "string", "x-go-name": "EntityA" }, "entityAFamily": { "type": "string", "x-go-name": "EntityAFamily" }, "entityAType": { "type": "string", "x-go-name": "EntityAType" }, "entityB": { "type": "string", "x-go-name": "EntityB" }, "entityBFamily": { "type": "string", "x-go-name": "EntityBFamily" }, "entityBType": { "type": "string", "x-go-name": "EntityBType" }, "fields": { "$ref": "#/components/schemas/CustomFields" }, "id": { "type": "string", "x-go-name": "ID" }, "instance": { "type": "string", "x-go-name": "Instance" }, "name": { "type": "string", "x-go-name": "Name" }, "reliability": { "$ref": "#/components/schemas/Reliability" }, "reverseName": { "type": "string", "x-go-name": "ReverseName" }, "startTime": { "type": "string", "format": "date-time", "x-go-name": "StartTime" }, "type": { "type": "string", "x-go-name": "TypeID" } }, "x-go-package": "github.com/demisto/server/domain" }, "Reliability": { "type": "string", "title": "Reliability ...", "x-go-package": "github.com/demisto/server/domain" }, "Mapper": { "type": "object", "description": "Mapper - mapper for new incidents", "properties": { "dontMapEventToLabels": { "type": "boolean", "description": "DontMapEventToLabels by default we will map all the fields of the event to incident labels", "x-go-name": "DontMapEventToLabels" }, "internalMapping": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "InternalMapping" } }, "x-go-package": "github.com/demisto/server/domain" }, "AdvanceArg": { "type": "object", "title": "AdvanceArg - advance argument can be one of the following:", "description": "Simple: plain text such as \"hello\" (constant) or ${File.ID} (DT expression)\nComplex: struct with all info that is necessary to compute argument value from context (Root, Filters, Accessor & Transformers)]\nKeyValue: list of key-value", "properties": { "complex": { "$ref": "#/components/schemas/ComplexArg" }, "keyValue": { "type": "array", "items": { "$ref": "#/components/schemas/KeyValueArg" }, "x-go-name": "KeyValue" }, "simple": { "type": "string", "x-go-name": "Simple" } }, "x-go-package": "github.com/demisto/server/domain" }, "ComplexArg": { "type": "object", "description": "ComplexArg - all info that is necessary to compute argument value from context\nRoot - the root slice (or object) from to work against\nFilters - a slice of filters to apply to the root object, one after another (e.i. with AND condition between each one)\nAccessor - the key to access to each result after filter\nTransformers - a slice to transformers to apply on the result of the accessed key from each result\ne.g. if user want to take from context all File.DisplayName where File.Extension is 'EXE', and the result in uppercase than:\nRoot: is \"File\"\nFilters: will hold the \"File.DisplayName where File.Extension is 'EXE'\" query\nAccessor: is \"DisplayName\"\nTransformers: will hold the uppercase transformation", "properties": { "accessor": { "type": "string", "x-go-name": "Accessor" }, "filters": { "type": "array", "items": { "$ref": "#/components/schemas/ArgFilter" }, "x-go-name": "Filters" }, "root": { "type": "string", "x-go-name": "Root" }, "transformers": { "type": "array", "items": { "$ref": "#/components/schemas/ArgTransformer" }, "x-go-name": "Transformers" } }, "x-go-package": "github.com/demisto/server/domain" }, "ArgFilter": { "type": "array", "description": "ArgFilter - represent a slice of atomic filters with OR condition between them (e.i. - atomic1 OR atomic2 OR ...)", "items": { "$ref": "#/components/schemas/ArgAtomicFilter" }, "x-go-package": "github.com/demisto/server/domain" }, "ArgAtomicFilter": { "type": "object", "description": "ArgAtomicFilter - operator with two sides that return true/false", "properties": { "ignoreCase": { "type": "boolean", "x-go-name": "IgnoreCase" }, "left": { "$ref": "#/components/schemas/OperatorArgument" }, "operator": { "$ref": "#/components/schemas/FilterOperatorID" }, "right": { "$ref": "#/components/schemas/OperatorArgument" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "OperatorArgument": { "type": "object", "title": "OperatorArgument ...", "properties": { "isContext": { "type": "boolean", "x-go-name": "IsContext" }, "value": { "$ref": "#/components/schemas/AdvanceArg" } }, "x-go-package": "github.com/demisto/server/domain" }, "FilterOperatorID": { "type": "string", "title": "FilterOperatorID ...", "x-go-package": "github.com/demisto/server/domain" }, "ArgTransformer": { "type": "object", "title": "ArgTransformer ...", "properties": { "args": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperatorArgument" }, "x-go-name": "Args" }, "operator": { "$ref": "#/components/schemas/TransformerOperatorID" } }, "x-go-package": "github.com/demisto/server/domain" }, "TransformerOperatorID": { "type": "string", "title": "TransformerOperatorID ...", "x-go-package": "github.com/demisto/server/domain" }, "KeyValueArg": { "type": "object", "title": "KeyValueArg ...", "properties": { "key": { "type": "string", "x-go-name": "Key" }, "value": { "$ref": "#/components/schemas/AdvanceArg" } }, "x-go-package": "github.com/demisto/server/domain" }, "MapperType": { "type": "string", "description": "MapperType for instance classifier", "x-go-package": "github.com/demisto/server/domain" }, "UnclassifiedCases": { "type": "object", "title": "UnclassifiedCases ...", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-package": "github.com/demisto/server/domain" }, "Dashboard": { "type": "object", "title": "Dashboard ...", "properties": { "accounts": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "hidePivot": { "type": "boolean", "x-go-name": "HidePivot" }, "hideSearch": { "type": "boolean", "x-go-name": "HideSearch" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "isCommon": { "type": "boolean", "x-go-name": "IsCommon" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "layout": { "$ref": "#/components/schemas/WidgetCells" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "modulePage": { "type": "boolean", "x-go-name": "ModulePage" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "owner": { "type": "string", "x-go-name": "Owner" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "period": { "$ref": "#/components/schemas/Period" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "WidgetCells": { "type": "array", "title": "WidgetCells ...", "items": { "$ref": "#/components/schemas/WidgetCell" }, "x-go-package": "github.com/demisto/server/domain" }, "WidgetCell": { "type": "object", "title": "WidgetCell ...", "properties": { "forceRange": { "type": "boolean", "x-go-name": "ForceRange" }, "h": { "type": "integer", "format": "int64", "x-go-name": "Height" }, "i": { "type": "string", "x-go-name": "Key" }, "id": { "type": "string", "x-go-name": "ID" }, "reflectDimensions": { "type": "boolean", "x-go-name": "ReflectDimensions" }, "w": { "type": "integer", "format": "int64", "x-go-name": "Width" }, "widget": { "$ref": "#/components/schemas/Widget" }, "x": { "type": "integer", "format": "int64", "x-go-name": "Xs" }, "y": { "type": "integer", "format": "int64", "x-go-name": "Ys" } }, "x-go-package": "github.com/demisto/server/domain" }, "Widget": { "type": "object", "description": "Widget describe a widget component used to get statistics requests, based on parameters such as\ndataType and widgetType. A widget can be a part of widgets collection inside a dashboard.", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "accounts": { "type": "object", "description": "Accounts list of accounts to query the widget data from", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "category": { "type": "string", "description": "Category the widget is related to. Used to display in widget library under category or dataType if empty.", "x-go-name": "Category" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dataType": { "type": "string", "description": "Data type of the widget. Describes what data does the widget query. supporting data types \"incidents\",\"messages\",\"system\",\"entries\",\"tasks\", \"audit\".", "x-go-name": "DataType" }, "dateRange": { "$ref": "#/components/schemas/DateRange" }, "definition": { "$ref": "#/components/schemas/GenericObjectDefinition" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "description": { "type": "string", "description": "The description of the widget's usage and data representation.", "x-go-name": "Description" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "isPredefined": { "type": "boolean", "description": "Is the widget a system widget.", "x-go-name": "IsPredefined" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "locked": { "type": "boolean", "description": "Is the widget locked for editing.", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "description": "Default name of the widget.", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "params": { "type": "object", "description": "Additional parameters for this widget, depends on widget type and data.", "additionalProperties": { "type": "object" }, "x-go-name": "AdditionalParams" }, "prevName": { "type": "string", "description": "The previous name of the widget.", "x-go-name": "PrevName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "query": { "type": "string", "description": "Query to search on the dataType.", "x-go-name": "Query" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "skipAggregateAccounts": { "type": "boolean", "description": "SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results", "x-go-name": "SkipAggregateAccounts" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "widgetType": { "type": "string", "description": "Widget type describes how does the widget should recieve the data, and display it. Supporting types: \"bar\", \"column\", \"pie\", \"list\", \"number\", \"trend\", \"text\", \"duration\", \"image\", \"line\", and \"table\".", "x-go-name": "WidgetType" } }, "required": [ "name", "widgetType" ], "x-go-package": "github.com/demisto/server/domain" }, "DateRange": { "type": "object", "description": "DateRange provides common fields for date filtering", "properties": { "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "period": { "$ref": "#/components/schemas/Period" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" } }, "x-go-package": "github.com/demisto/server/domain" }, "Period": { "type": "object", "title": "Period holds the 'Period' query, such as last 3 days, last 6 hours, between 6 days from now until 3 days from now.", "properties": { "by": { "type": "string", "description": "By is used for legacty, and if exists it will override ByTo and ByFrom", "x-go-name": "By" }, "byFrom": { "type": "string", "x-go-name": "ByFrom" }, "byTo": { "type": "string", "x-go-name": "ByTo" }, "field": { "type": "string", "x-go-name": "Field" }, "fromValue": { "type": "string", "format": "duration", "x-go-name": "FromValue" }, "toValue": { "type": "string", "format": "duration", "x-go-name": "ToValue" } }, "x-go-package": "github.com/demisto/server/domain" }, "GenericObjectDefinition": { "type": "object", "title": "GenericObjectDefinition ...", "properties": { "auditable": { "type": "boolean", "x-go-name": "Auditable" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "partitioned": { "type": "boolean", "x-go-name": "Partitioned" }, "pluralName": { "type": "string", "x-go-name": "PluralName" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "rbacSupport": { "type": "boolean", "x-go-name": "RBACSupport" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "updateEntry": { "type": "object", "properties": { "args": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "Args" }, "data": { "type": "string", "x-go-name": "Data" }, "id": { "type": "string", "x-go-name": "ID" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" }, "markdown": { "type": "boolean", "x-go-name": "Markdown" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/web" }, "Entry": { "type": "object", "description": "Entry holds a single entry in an investigation. Entries entered within a short amount of time by the same user are combined", "properties": { "IndicatorTimeline": { "$ref": "#/components/schemas/IndicatorTimeline" }, "InstanceID": { "type": "string" }, "Relationships": { "$ref": "#/components/schemas/RelationshipsAPI" }, "ShardID": { "type": "integer", "format": "int64" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "apiExecutionMetrics": { "type": "array", "items": { "$ref": "#/components/schemas/APIExecutionMetric" }, "x-go-name": "APIExecutionMetrics" }, "brand": { "type": "string", "x-go-name": "Brand" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "category": { "$ref": "#/components/schemas/EntryCategory" }, "contents": { "type": "object", "description": "The contents of the entry that is actually indexed - should not be used", "x-go-name": "DoNotUseContents" }, "contentsSize": { "type": "integer", "description": "ContentsSize the total size of the contents", "format": "int64", "x-go-name": "ContentsSize" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "cron": { "type": "string", "x-go-name": "Cron" }, "cronView": { "type": "boolean", "x-go-name": "CronView" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "deleted": { "type": "boolean", "x-go-name": "Deleted" }, "deletedBy": { "type": "string", "x-go-name": "DeletedBy" }, "deletedFromFS": { "type": "boolean", "x-go-name": "DeletedFromFS" }, "endingDate": { "type": "string", "format": "date-time", "x-go-name": "EndingDate" }, "endingType": { "$ref": "#/components/schemas/EndingType" }, "entryTask": { "$ref": "#/components/schemas/EntryTask" }, "errorSource": { "type": "string", "description": "Source of the error", "x-go-name": "ErrorSource" }, "file": { "type": "string", "description": "Filename of associated content", "x-go-name": "File" }, "fileID": { "type": "string", "description": "FileID is the file name when saved in the server", "x-go-name": "FileID" }, "fileMetadata": { "$ref": "#/components/schemas/FileMetadata" }, "format": { "type": "string", "description": "Holds information on how content is formatted", "x-go-name": "ContentsFormat" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "history": { "type": "array", "description": "Edit history", "items": { "$ref": "#/components/schemas/EntryHistory" }, "x-go-name": "History" }, "humanCron": { "$ref": "#/components/schemas/HumanCron" }, "id": { "type": "string", "x-go-name": "ID" }, "incidentCreationTime": { "type": "string", "description": "store the entry based on IncidentCreationTime", "format": "date-time", "x-go-name": "IncidentCreationTime" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "instance": { "type": "string", "x-go-name": "Instance" }, "investigationId": { "type": "string", "description": "The id of the investigation it belongs to", "x-go-name": "InvestigationID" }, "isTodo": { "type": "boolean", "description": "IsTodo", "x-go-name": "IsTodo" }, "mirrored": { "type": "boolean", "description": "Only used for outbound mirroring to mark that it is already mirrored to remote system", "x-go-name": "Mirrored" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "note": { "type": "boolean", "description": "Note", "x-go-name": "Note" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "parentContent": { "type": "object", "description": "ParentEntry content - for reference", "x-go-name": "ParentEntryContent" }, "parentEntryTruncated": { "type": "boolean", "description": "ParentEntryTruncated - indicates weather entry content was truncated", "x-go-name": "ParentEntryTruncated" }, "parentId": { "type": "string", "description": "ParentId is the ID of the parent entry", "x-go-name": "ParentID" }, "pinned": { "type": "boolean", "description": "Mark entry as pinned = evidence", "x-go-name": "Pinned" }, "playbookId": { "type": "string", "description": "PlaybookID - if the entry is assigned as note to a playbook task, it will hold the playbook", "x-go-name": "PlaybookID" }, "polling": { "type": "boolean", "description": "Only used for polling entries", "x-go-name": "Polling" }, "pollingArgs": { "$ref": "#/components/schemas/ModuleArgs" }, "pollingCommand": { "type": "string", "x-go-name": "PollingCommand" }, "pollingItemsRemaining": { "type": "integer", "format": "int64", "x-go-name": "PollingItemsRemaining" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "readOnly": { "type": "boolean", "description": "ReadOnly", "x-go-name": "ReadOnly" }, "recurrent": { "type": "boolean", "x-go-name": "Recurrent" }, "reputationSize": { "type": "integer", "description": "ReputationSize the total size of the reputation", "format": "int64", "x-go-name": "ReputationSize" }, "reputations": { "type": "array", "description": "EntryReputations the reputations calculated by regex match", "items": { "$ref": "#/components/schemas/EntryReputation" }, "x-go-name": "EntryReputations" }, "retryTime": { "type": "string", "description": "When retry took place", "format": "date-time", "x-go-name": "RetryTime" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "scheduled": { "type": "boolean", "description": "is it scheduled", "x-go-name": "Scheduled" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "startDate": { "type": "string", "format": "date-time", "x-go-name": "StartDate" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "string", "description": "The name of the system associated with this entry", "x-go-name": "SystemName" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string" }, "x-go-name": "Tags" }, "tagsRaw": { "type": "array", "description": "TagsRaw", "items": { "type": "string" }, "x-go-name": "TagsRaw" }, "taskId": { "type": "string", "description": "TaskID - used if the entry is assigned as note to a playbook task", "x-go-name": "TaskID" }, "times": { "type": "integer", "format": "int64", "x-go-name": "Times" }, "timesRan": { "type": "integer", "format": "int64", "x-go-name": "TimesRan" }, "timezone": { "type": "string", "x-go-name": "Timezone" }, "timezoneOffset": { "type": "integer", "format": "int64", "x-go-name": "TimezoneOffset" }, "type": { "$ref": "#/components/schemas/EntryType" }, "user": { "type": "string", "description": "The user who created the entry", "x-go-name": "User" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "IndicatorTimeline": { "type": "array", "title": "IndicatorTimeline ...", "items": { "$ref": "#/components/schemas/IndicatorTimelineFromEntry" }, "x-go-package": "github.com/demisto/server/domain" }, "IndicatorTimelineFromEntry": { "type": "object", "title": "IndicatorTimelineFromEntry ...", "properties": { "Category": { "type": "string" }, "Message": { "type": "string" }, "Source": { "type": "string" }, "Time": { "type": "string", "format": "date-time" }, "User": { "type": "string" }, "Value": { "type": "array", "items": { "type": "string" } } }, "x-go-package": "github.com/demisto/server/domain" }, "APIExecutionMetric": { "type": "object", "description": "APIExecutionMetric is used by an entry to indicate the api details of an execution", "properties": { "apiCallsCount": { "type": "integer", "format": "int64", "x-go-name": "APICallsCount" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "EntryCategory": { "type": "string", "title": "EntryCategory ...", "x-go-package": "github.com/demisto/server/domain" }, "EndingType": { "type": "string", "description": "EndingType holds the type of schedule Ending", "x-go-package": "github.com/demisto/server/domain" }, "EntryTask": { "type": "object", "description": "EntryTask holds information regarding the related task", "properties": { "playbookName": { "type": "string", "x-go-name": "PlaybookName" }, "quiet": { "type": "boolean", "x-go-name": "Quiet" }, "taskId": { "type": "string", "x-go-name": "TaskID" }, "taskName": { "type": "string", "x-go-name": "TaskName" }, "taskStatus": { "type": "string", "x-go-name": "TaskStatus" } }, "x-go-package": "github.com/demisto/server/domain" }, "FileMetadata": { "type": "object", "title": "FileMetadata ...", "properties": { "info": { "type": "string", "x-go-name": "Info" }, "isMediaFile": { "type": "boolean", "x-go-name": "IsMediaFile" }, "md5": { "type": "string", "x-go-name": "MD5" }, "sha1": { "type": "string", "x-go-name": "SHA1" }, "sha256": { "type": "string", "x-go-name": "SHA256" }, "sha512": { "type": "string", "x-go-name": "SHA512" }, "size": { "type": "integer", "format": "int64", "x-go-name": "Size" }, "ssdeep": { "type": "string", "x-go-name": "SSDeep" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "EntryHistory": { "type": "object", "title": "EntryHistory ...", "properties": { "contentDate": { "type": "string", "format": "date-time", "x-go-name": "ContentDate" }, "contents": { "type": "string", "x-go-name": "Contents" }, "contentsFormat": { "type": "string", "x-go-name": "ContentsFormat" }, "user": { "type": "string", "x-go-name": "User" } }, "x-go-package": "github.com/demisto/server/domain" }, "HumanCron": { "type": "object", "title": "HumanCron ...", "properties": { "atTimeHour": { "type": "string", "x-go-name": "AtTimeHour" }, "atTimeMinute": { "type": "string", "x-go-name": "AtTimeMinute" }, "days": { "type": "array", "items": { "type": "string" }, "x-go-name": "Days" }, "schedulingType": { "type": "string", "description": "the following fields are deprecated. do not use them.", "x-go-name": "SchedulingType" }, "timePeriod": { "type": "integer", "format": "int64", "x-go-name": "TimePeriod" }, "timePeriodType": { "type": "string", "x-go-name": "TimePeriodType" } }, "x-go-package": "github.com/demisto/server/domain" }, "ModuleArgs": { "type": "object", "description": "ModuleArgs represents module args", "additionalProperties": { "type": "object" }, "x-go-package": "github.com/demisto/server/domain" }, "EntryReputation": { "type": "object", "description": "EntryReputation holds the entry reputations and the highlights", "properties": { "highlights": { "$ref": "#/components/schemas/FieldTermLocationMap" }, "reputationsData": { "type": "array", "items": { "$ref": "#/components/schemas/ReputationData" }, "x-go-name": "ReputationsData" } }, "x-go-package": "github.com/demisto/server/domain" }, "FieldTermLocationMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TermLocationMap" }, "x-go-package": "github.com/blevesearch/bleve/v2/search" }, "TermLocationMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Locations" }, "x-go-package": "github.com/blevesearch/bleve/v2/search" }, "Locations": { "type": "array", "items": { "$ref": "#/components/schemas/Location" }, "x-go-package": "github.com/blevesearch/bleve/v2/search" }, "Location": { "type": "object", "properties": { "array_positions": { "$ref": "#/components/schemas/ArrayPositions" }, "end": { "type": "integer", "format": "uint64", "x-go-name": "End" }, "pos": { "type": "integer", "description": "Pos is the position of the term within the field, starting at 1", "format": "uint64", "x-go-name": "Pos" }, "start": { "type": "integer", "description": "Start and End are the byte offsets of the term in the field", "format": "uint64", "x-go-name": "Start" } }, "x-go-package": "github.com/blevesearch/bleve/v2/search" }, "ArrayPositions": { "type": "array", "items": { "type": "integer", "format": "uint64" }, "x-go-package": "github.com/blevesearch/bleve/v2/search" }, "ReputationData": { "type": "object", "description": "ReputationData holds the reputation data (reputation, regex, highlights result)", "properties": { "rawTerm": { "type": "string", "x-go-name": "RawTerm" }, "reputation": { "type": "integer", "format": "int64", "x-go-name": "Reputation" }, "reputationId": { "type": "string", "x-go-name": "ReputationID" }, "term": { "type": "string", "x-go-name": "Term" } }, "x-go-package": "github.com/demisto/server/domain" }, "EntryType": { "type": "number", "description": "EntryType specifies the type of the entry", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "DownloadEntry": { "type": "object", "title": "DownloadEntry ...", "properties": { "id": { "type": "string", "x-go-name": "ID" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" } }, "x-go-package": "github.com/demisto/server/web" }, "uploadedEntry": { "type": "object", "properties": { "contents": { "type": "string", "x-go-name": "Contents" }, "format": { "type": "string", "x-go-name": "ContentsFormat" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" } }, "x-go-package": "github.com/demisto/server/web" }, "updateEntryTags": { "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/web" }, "Evidence": { "type": "object", "title": "Evidence details.", "properties": { "ShardID": { "type": "integer", "format": "int64" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "description": { "type": "string", "description": "The description for the resolve", "x-go-name": "Description" }, "entryId": { "type": "string", "description": "The entry ID", "x-go-name": "EntryID" }, "fetched": { "type": "string", "description": "when the evidence entry was fetched", "format": "date-time", "x-go-name": "Fetched" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "incidentId": { "type": "string", "description": "The incident ID", "x-go-name": "IncidentID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "markedBy": { "type": "string", "description": "the user that marked this evidence", "x-go-name": "MarkedBy" }, "markedDate": { "type": "string", "description": "when this evidence was marked", "format": "date-time", "x-go-name": "MarkedDate" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "occurred": { "type": "string", "description": "When this evidence has occurred", "format": "date-time", "x-go-name": "Occurred" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string" }, "x-go-name": "Tags" }, "tagsRaw": { "type": "array", "description": "TagsRaw", "items": { "type": "string" }, "x-go-name": "TagsRaw" }, "taskId": { "type": "string", "description": "when the evidence entry was fetched", "x-go-name": "TaskID" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "deleteEvidence": { "type": "object", "properties": { "evidenceID": { "type": "string", "x-go-name": "EvidenceID" } }, "x-go-package": "github.com/demisto/server/web" }, "evidencesFilterWrapper": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/GenericStringDateFilter" }, "incidentID": { "type": "string", "x-go-name": "IncidentID" } }, "x-go-package": "github.com/demisto/server/web" }, "GenericStringDateFilter": { "type": "object", "description": "GenericStringDateFilter is a general filter that will fetch entities using the Query value and a date filter", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "accounts": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "fields": { "type": "array", "items": { "type": "string" }, "x-go-name": "Fields" }, "filterobjectquery": { "type": "string", "x-go-name": "FilterObjectQuery" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "period": { "$ref": "#/components/schemas/Period" }, "query": { "type": "string", "x-go-name": "Query" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "trim_events": { "type": "integer", "format": "int64", "x-go-name": "TrimEvents" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "EvidencesSearchResponse": { "type": "object", "description": "EvidencesSearchResponse returns the response from the evidences search", "properties": { "evidences": { "$ref": "#/components/schemas/Evidences" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Evidences": { "type": "array", "description": "Evidences is a list of evidence entities", "items": { "$ref": "#/components/schemas/Evidence" }, "x-go-package": "github.com/demisto/server/domain" }, "containersInfo": { "type": "object", "description": "Info - holds all containers info", "properties": { "all": { "type": "integer", "format": "int64", "x-go-name": "All" }, "inactive": { "type": "integer", "format": "int64", "x-go-name": "Inactive" }, "running": { "type": "integer", "format": "int64", "x-go-name": "Running" } }, "x-go-name": "Info", "x-go-package": "github.com/demisto/server/services/containers/containersInfo" }, "CreateIncidentRequest": { "type": "object", "description": "CreateIncidentRequest is an extension for Incident entity, with additional field of changed-status for the web client.", "properties": { "ShardID": { "type": "integer", "format": "int64" }, "account": { "type": "string", "description": "Account holds the tenant name so that slicing and dicing on the master can leverage bleve", "x-go-name": "Account" }, "activated": { "type": "string", "description": "When was this activated", "format": "date-time", "x-go-name": "Activated" }, "activatingingUserId": { "type": "string", "description": "The user that activated this investigation", "x-go-name": "ActivatingUserID" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "autime": { "type": "integer", "description": "AlmostUniqueTime is an attempt to have a unique sortable ID for an incident", "format": "int64", "x-go-name": "AlmostUniqueTime" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "canvases": { "type": "array", "description": "Canvases of the incident", "items": { "type": "string" }, "x-go-name": "Canvases" }, "category": { "type": "string", "description": "Category", "x-go-name": "Category" }, "closeNotes": { "type": "string", "description": "Notes for closing the incident", "x-go-name": "CloseNotes" }, "closeReason": { "type": "string", "description": "The reason for closing the incident (select from existing predefined values)", "x-go-name": "ArchiveReason" }, "closed": { "type": "string", "description": "When was this closed", "format": "date-time", "x-go-name": "Closed" }, "closingUserId": { "type": "string", "description": "The user ID that closed this investigation", "x-go-name": "ClosingUserID" }, "createInvestigation": { "type": "boolean", "x-go-name": "CreateInvestigation" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "dbotCurrentDirtyFields": { "type": "array", "description": "For mirroring, manage a list of current dirty fields so that we can send delta to outgoing integration", "items": { "type": "string" }, "x-go-name": "DBotCurrentDirtyFields" }, "dbotDirtyFields": { "type": "array", "description": "For mirroring, manage a list of dirty fields to not override them from the source of the incident", "items": { "type": "string" }, "x-go-name": "DBotDirtyFields" }, "dbotMirrorDirection": { "type": "string", "description": "DBotMirrorDirection of how to mirror the incident (in/out/both)", "x-go-name": "DBotMirrorDirection" }, "dbotMirrorId": { "type": "string", "description": "DBotMirrorID of a remote system we are syncing with", "x-go-name": "DBotMirrorID" }, "dbotMirrorInstance": { "type": "string", "description": "DBotMirrorInstance name of a mirror integration instance", "x-go-name": "DBotMirrorInstance" }, "dbotMirrorLastSync": { "type": "string", "description": "The last time we synced this incident even if we did not update anything", "format": "date-time", "x-go-name": "DBotMirrorLastSync" }, "dbotMirrorTags": { "type": "array", "description": "The entry tags I want to sync to remote system", "items": { "type": "string" }, "x-go-name": "DBotMirrorEntryTags" }, "details": { "type": "string", "description": "The details of the incident - reason, etc.", "x-go-name": "Details" }, "droppedCount": { "type": "integer", "description": "DroppedCount ...", "format": "int64", "x-go-name": "DroppedCount" }, "dueDate": { "type": "string", "description": "SLA", "format": "date-time", "x-go-name": "DueDate" }, "feedBased": { "type": "boolean", "description": "If this incident was triggered by a feed job", "x-go-name": "FeedBased" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "investigationId": { "type": "string", "description": "Investigation that was opened as a result of the incoming event", "x-go-name": "Investigation" }, "isDebug": { "type": "boolean", "description": "IsDebug ...", "x-go-name": "IsDebug" }, "isPlayground": { "type": "boolean", "description": "IsPlayGround", "x-go-name": "IsPlayGround" }, "labels": { "type": "array", "description": "Labels related to incident - each label is composed of a type and value", "items": { "$ref": "#/components/schemas/Label" }, "x-go-name": "Labels" }, "lastJobRunTime": { "type": "string", "description": "If this incident was triggered by a job, this would be the time the **previous** job started", "format": "date-time", "x-go-name": "LastJobRunTime" }, "lastOpen": { "type": "string", "format": "date-time", "x-go-name": "LastOpen" }, "linkedCount": { "type": "integer", "description": "LinkedCount ...", "format": "int64", "x-go-name": "LinkedCount" }, "linkedIncidents": { "type": "array", "description": "LinkedIncidents incidents that were marked as linked by user", "items": { "type": "string" }, "x-go-name": "LinkedIncidents" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "description": "Incident Name - given by user", "x-go-name": "Name" }, "notifyTime": { "type": "string", "description": "Incdicates when last this field was changed with a value that supposed to send a notification", "format": "date-time", "x-go-name": "NotifyTime" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "occurred": { "type": "string", "description": "When this incident has really occurred", "format": "date-time", "x-go-name": "Occurred" }, "openDuration": { "type": "integer", "description": "Duration incident was open", "format": "int64", "x-go-name": "OpenDuration" }, "owner": { "type": "string", "description": "The user who owns this incident", "x-go-name": "OwnerID" }, "parent": { "type": "string", "description": "Parent", "x-go-name": "Parent" }, "phase": { "type": "string", "description": "Phase", "x-go-name": "Phase" }, "playbookId": { "type": "string", "description": "The associated playbook for this incident", "x-go-name": "PlaybookID" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "rawCategory": { "type": "string", "x-go-name": "RawCategory" }, "rawCloseReason": { "type": "string", "description": "The reason for closing the incident (select from existing predefined values)", "x-go-name": "RawArchiveReason" }, "rawJSON": { "type": "string", "x-go-name": "RawJSONData" }, "rawName": { "type": "string", "description": "Incident RawName", "x-go-name": "RawName" }, "rawPhase": { "type": "string", "description": "RawPhase", "x-go-name": "RawPhase" }, "rawType": { "type": "string", "description": "Incident raw type", "x-go-name": "RawType" }, "reason": { "type": "string", "description": "The reason an incident was closed.", "x-go-name": "Reason" }, "reminder": { "type": "string", "description": "When if at all to send a reminder", "format": "date-time", "x-go-name": "Reminder" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "runStatus": { "$ref": "#/components/schemas/RunStatus" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "severity": { "$ref": "#/components/schemas/Severity" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sla": { "$ref": "#/components/schemas/SLAState" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourceBrand": { "type": "string", "description": "SourceBrand ...", "x-go-name": "SourceBrand" }, "sourceInstance": { "type": "string", "description": "SourceInstance ...", "x-go-name": "SourceInstance" }, "status": { "$ref": "#/components/schemas/IncidentStatus" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "todoTaskIds": { "type": "array", "description": "ToDoTaskIDs list of to do task ids", "items": { "type": "string" }, "x-go-name": "ToDoTaskIDs" }, "type": { "type": "string", "description": "Incident type", "x-examples": [ "Unclassified" ], "x-go-name": "Type" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "Label": { "type": "object", "title": "Label ...", "properties": { "type": { "type": "string", "x-go-name": "Type" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "github.com/demisto/server/domain" }, "RunStatus": { "type": "string", "description": "RunStatus of a job", "x-go-package": "github.com/demisto/server/domain" }, "Severity": { "type": "number", "description": "Severity is the incident severity", "format": "double", "minimum": 0, "multipleOf": 4, "x-go-package": "github.com/demisto/server/domain" }, "SLAState": { "type": "number", "description": "SLAState is the incident sla at closure time, in minutes.", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "IncidentStatus": { "type": "number", "description": "IncidentStatus is the status of the incident", "format": "double", "minimum": 0, "maximum": 2, "x-go-package": "github.com/demisto/server/domain" }, "IncidentWrapper": { "type": "object", "description": "IncidentWrapper is an extension of the Incident entity, which includes an additional field of changed-status for the web client", "properties": { "ShardID": { "type": "integer", "format": "int64" }, "account": { "type": "string", "description": "Account holds the tenant name so that slicing and dicing on the master can leverage bleve", "x-go-name": "Account" }, "activated": { "type": "string", "description": "When was this activated", "format": "date-time", "x-go-name": "Activated" }, "activatingingUserId": { "type": "string", "description": "The user that activated this investigation", "x-go-name": "ActivatingUserID" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "attachment": { "type": "array", "description": "Attachments", "items": { "$ref": "#/components/schemas/Attachment" }, "x-go-name": "Attachments" }, "autime": { "type": "integer", "description": "AlmostUniqueTime is an attempt to have a unique sortable ID for an incident", "format": "int64", "x-go-name": "AlmostUniqueTime" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "canvases": { "type": "array", "description": "Canvases of the incident", "items": { "type": "string" }, "x-go-name": "Canvases" }, "category": { "type": "string", "description": "Category", "x-go-name": "Category" }, "changeStatus": { "type": "string", "x-go-name": "ChangeStatus" }, "closeNotes": { "type": "string", "description": "Notes for closing the incident", "x-go-name": "CloseNotes" }, "closeReason": { "type": "string", "description": "The reason for closing the incident (select from existing predefined values)", "x-go-name": "ArchiveReason" }, "closed": { "type": "string", "description": "When was this closed", "format": "date-time", "x-go-name": "Closed" }, "closingUserId": { "type": "string", "description": "The user ID that closed this investigation", "x-go-name": "ClosingUserID" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "dbotCurrentDirtyFields": { "type": "array", "description": "For mirroring, manage a list of current dirty fields so that we can send delta to outgoing integration", "items": { "type": "string" }, "x-go-name": "DBotCurrentDirtyFields" }, "dbotDirtyFields": { "type": "array", "description": "For mirroring, manage a list of dirty fields to not override them from the source of the incident", "items": { "type": "string" }, "x-go-name": "DBotDirtyFields" }, "dbotMirrorDirection": { "type": "string", "description": "DBotMirrorDirection of how to mirror the incident (in/out/both)", "x-go-name": "DBotMirrorDirection" }, "dbotMirrorId": { "type": "string", "description": "DBotMirrorID of a remote system we are syncing with", "x-go-name": "DBotMirrorID" }, "dbotMirrorInstance": { "type": "string", "description": "DBotMirrorInstance name of a mirror integration instance", "x-go-name": "DBotMirrorInstance" }, "dbotMirrorLastSync": { "type": "string", "description": "The last time we synced this incident even if we did not update anything", "format": "date-time", "x-go-name": "DBotMirrorLastSync" }, "dbotMirrorTags": { "type": "array", "description": "The entry tags I want to sync to remote system", "items": { "type": "string" }, "x-go-name": "DBotMirrorEntryTags" }, "details": { "type": "string", "description": "The details of the incident - reason, etc.", "x-go-name": "Details" }, "droppedCount": { "type": "integer", "description": "DroppedCount ...", "format": "int64", "x-go-name": "DroppedCount" }, "dueDate": { "type": "string", "description": "SLA", "format": "date-time", "x-go-name": "DueDate" }, "feedBased": { "type": "boolean", "description": "If this incident was triggered by a feed job", "x-go-name": "FeedBased" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "insights": { "type": "integer", "format": "uint64", "x-go-name": "Insights" }, "investigationId": { "type": "string", "description": "Investigation that was opened as a result of the incoming event", "x-go-name": "Investigation" }, "isDebug": { "type": "boolean", "description": "IsDebug ...", "x-go-name": "IsDebug" }, "isPlayground": { "type": "boolean", "description": "IsPlayGround", "x-go-name": "IsPlayGround" }, "labels": { "type": "array", "description": "Labels related to incident - each label is composed of a type and value", "items": { "$ref": "#/components/schemas/Label" }, "x-go-name": "Labels" }, "lastJobRunTime": { "type": "string", "description": "If this incident was triggered by a job, this would be the time the **previous** job started", "format": "date-time", "x-go-name": "LastJobRunTime" }, "lastOpen": { "type": "string", "format": "date-time", "x-go-name": "LastOpen" }, "linkedCount": { "type": "integer", "description": "LinkedCount ...", "format": "int64", "x-go-name": "LinkedCount" }, "linkedIncidents": { "type": "array", "description": "LinkedIncidents incidents that were marked as linked by user", "items": { "type": "string" }, "x-go-name": "LinkedIncidents" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "description": "Incident Name - given by user", "x-go-name": "Name" }, "notifyTime": { "type": "string", "description": "Incdicates when last this field was changed with a value that supposed to send a notification", "format": "date-time", "x-go-name": "NotifyTime" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "occurred": { "type": "string", "description": "When this incident has really occurred", "format": "date-time", "x-go-name": "Occurred" }, "openDuration": { "type": "integer", "description": "Duration incident was open", "format": "int64", "x-go-name": "OpenDuration" }, "owner": { "type": "string", "description": "The user who owns this incident", "x-go-name": "OwnerID" }, "parent": { "type": "string", "description": "Parent", "x-go-name": "Parent" }, "phase": { "type": "string", "description": "Phase", "x-go-name": "Phase" }, "playbookId": { "type": "string", "description": "The associated playbook for this incident", "x-go-name": "PlaybookID" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "rawCategory": { "type": "string", "x-go-name": "RawCategory" }, "rawCloseReason": { "type": "string", "description": "The reason for closing the incident (select from existing predefined values)", "x-go-name": "RawArchiveReason" }, "rawJSON": { "type": "string", "x-go-name": "RawJSONData" }, "rawName": { "type": "string", "description": "Incident RawName", "x-go-name": "RawName" }, "rawPhase": { "type": "string", "description": "RawPhase", "x-go-name": "RawPhase" }, "rawType": { "type": "string", "description": "Incident raw type", "x-go-name": "RawType" }, "reason": { "type": "string", "description": "The reason for the resolve", "x-go-name": "Reason" }, "reminder": { "type": "string", "description": "When if at all to send a reminder", "format": "date-time", "x-go-name": "Reminder" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "runStatus": { "$ref": "#/components/schemas/RunStatus" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "severity": { "$ref": "#/components/schemas/Severity" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sla": { "$ref": "#/components/schemas/SLAState" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourceBrand": { "type": "string", "description": "SourceBrand ...", "x-go-name": "SourceBrand" }, "sourceInstance": { "type": "string", "description": "SourceInstance ...", "x-go-name": "SourceInstance" }, "status": { "$ref": "#/components/schemas/IncidentStatus" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "todoTaskIds": { "type": "array", "description": "ToDoTaskIDs list of to do task ids", "items": { "type": "string" }, "x-go-name": "ToDoTaskIDs" }, "type": { "type": "string", "description": "Incident type", "x-go-name": "Type" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "Attachment": { "type": "object", "title": "Attachment ...", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "isTempPath": { "type": "boolean", "x-go-name": "IsTempPath" }, "name": { "type": "string", "x-go-name": "Name" }, "path": { "type": "string", "x-go-name": "Path" }, "showMediaFile": { "type": "boolean", "x-go-name": "ShowMediaFile" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "UpdateDataBatch": { "type": "object", "title": "UpdateDataBatch ...", "properties": { "CustomFields": { "type": "object", "additionalProperties": { "type": "object" } }, "all": { "type": "boolean", "x-go-name": "All" }, "closeNotes": { "type": "string", "x-go-name": "CloseNotes" }, "closeReason": { "type": "string", "x-go-name": "CloseReason" }, "columns": { "type": "array", "items": { "type": "string" }, "x-go-name": "Columns" }, "data": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Data" }, "filter": { "$ref": "#/components/schemas/IncidentFilter" }, "force": { "type": "boolean", "x-go-name": "Force" }, "ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "IDs" }, "line": { "type": "string", "x-go-name": "Line" }, "originalIncidentId": { "type": "string", "x-go-name": "OriginalIncidentID" }, "overrideInvestigation": { "type": "boolean", "x-go-name": "OverrideInvestigation" } }, "x-go-package": "github.com/demisto/server/web" }, "IncidentFilter": { "type": "object", "title": "IncidentFilter allows for very simple filtering.", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "accounts": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "andOp": { "type": "boolean", "x-go-name": "AndOp" }, "category": { "type": "array", "items": { "type": "string" }, "x-go-name": "Category" }, "details": { "type": "string", "x-go-name": "Details" }, "fields": { "type": "array", "items": { "type": "string" }, "x-go-name": "Fields" }, "files": { "type": "array", "items": { "type": "string" }, "x-go-name": "Files" }, "filterobjectquery": { "type": "string", "x-go-name": "FilterObjectQuery" }, "fromActivatedDate": { "type": "string", "format": "date-time", "x-go-name": "FromActivatedDate" }, "fromClosedDate": { "type": "string", "format": "date-time", "x-go-name": "FromClosedDate" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "fromDueDate": { "type": "string", "format": "date-time", "x-go-name": "FromDueDate" }, "fromReminder": { "type": "string", "format": "date-time", "x-go-name": "FromReminder" }, "id": { "type": "array", "items": { "type": "string" }, "x-go-name": "ID" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "includeTmp": { "type": "boolean", "x-go-name": "IncludeTmp" }, "investigation": { "type": "array", "items": { "type": "string" }, "x-go-name": "Investigation" }, "level": { "type": "array", "items": { "$ref": "#/components/schemas/Severity" }, "x-go-name": "Level" }, "name": { "type": "array", "items": { "type": "string" }, "x-go-name": "Name" }, "notCategory": { "type": "array", "items": { "type": "string" }, "x-go-name": "NotCategory" }, "notInvestigation": { "type": "array", "items": { "type": "string" }, "x-go-name": "NotInvestigation" }, "notStatus": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "x-go-name": "NotStatus" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "parent": { "type": "array", "items": { "type": "string" }, "x-go-name": "Parent" }, "period": { "$ref": "#/components/schemas/Period" }, "query": { "type": "string", "description": "If you include the `query` parameter, all other filter fields will be ignored. \nTo include the other filter fields, they must be included as part of the query used as the `query` value.", "x-go-name": "Query" }, "reason": { "type": "array", "items": { "type": "string" }, "x-go-name": "Reason" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentStatus" }, "x-go-name": "Status" }, "systems": { "type": "array", "items": { "type": "string" }, "x-go-name": "Systems" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toActivatedDate": { "type": "string", "format": "date-time", "x-go-name": "ToActivatedDate" }, "toClosedDate": { "type": "string", "format": "date-time", "x-go-name": "ToClosedDate" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "toDueDate": { "type": "string", "format": "date-time", "x-go-name": "ToDueDate" }, "toReminder": { "type": "string", "format": "date-time", "x-go-name": "ToReminder" }, "totalOnly": { "type": "boolean", "x-go-name": "TotalOnly" }, "trim_events": { "type": "integer", "format": "int64", "x-go-name": "TrimEvents" }, "type": { "type": "array", "items": { "type": "string" }, "x-go-name": "Type" }, "urls": { "type": "array", "items": { "type": "string" }, "x-go-name": "Urls" }, "users": { "type": "array", "items": { "type": "string" }, "x-go-name": "Users" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "IncidentSearchResponseWrapper": { "type": "object", "description": "IncidentSearchResponseWrapper is an extension for the IncidentSearchResponse type, which holds list of IncidentWrapper(s)", "properties": { "accountErrors": { "type": "array", "items": { "type": "string" }, "x-go-name": "AccountErrors" }, "data": { "type": "array", "description": "in: body", "items": { "$ref": "#/components/schemas/IncidentWrapper" }, "x-go-name": "Data" }, "notUpdated": { "type": "integer", "format": "uint64", "x-go-name": "NotUpdated" }, "searchAfter": { "type": "array", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchBefore": { "type": "array", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" }, "totalAccounts": { "type": "integer", "format": "int64", "x-go-name": "TotalAccounts" } }, "x-go-package": "github.com/demisto/server/domain" }, "tagsFieldValues": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "x-go-name": "Data" } }, "x-go-package": "github.com/demisto/server/web" }, "IncidentField": { "type": "object", "title": "IncidentField ...", "properties": { "aliasTo": { "type": "string", "x-go-name": "AliasTo" }, "aliases": { "type": "array", "items": { "$ref": "#/components/schemas/FieldsAlias" }, "x-go-name": "Aliases" }, "associatedToAll": { "type": "boolean", "x-go-name": "AssociatedToAll" }, "associatedTypes": { "type": "array", "description": "AssociatedTypes - list of incident (case) types IDs related to specific incident field", "items": { "type": "string" }, "x-go-name": "AssociatedTypes" }, "autoCompleteTags": { "type": "array", "items": { "type": "string" }, "x-go-name": "AutoCompleteTags" }, "breachScript": { "type": "string", "x-go-name": "BreachScript" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "caseInsensitive": { "type": "boolean", "x-go-name": "CaseInsensitive" }, "cliName": { "type": "string", "x-go-name": "CliName" }, "closeForm": { "type": "boolean", "x-go-name": "CloseForm" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/GridColumn" }, "x-go-name": "GridColumns" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "content": { "type": "boolean", "x-go-name": "Content" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "defaultRows": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } }, "x-go-name": "DefaultRows" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "description": { "type": "string", "x-go-name": "Description" }, "editForm": { "type": "boolean", "x-go-name": "EditForm" }, "fieldCalcScript": { "type": "string", "x-go-name": "FieldCalcScript" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "group": { "$ref": "#/components/schemas/FieldGroup" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "isReadOnly": { "type": "boolean", "x-go-name": "IsReadOnly" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "mergeStrategy": { "$ref": "#/components/schemas/FieldMergeStrategy" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "neverSetAsRequired": { "type": "boolean", "x-go-name": "NeverSetAsRequired" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "openEnded": { "type": "boolean", "x-go-name": "OpenEnded" }, "orgType": { "type": "string", "x-go-name": "OrgType" }, "ownerOnly": { "type": "boolean", "x-go-name": "OwnerOnly" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "placeholder": { "type": "string", "x-go-name": "Placeholder" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "required": { "type": "boolean", "x-go-name": "Required" }, "runScriptAfterUpdate": { "type": "boolean", "x-go-name": "RunScriptAfterIncUpdate" }, "script": { "type": "string", "x-go-name": "Script" }, "selectValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SelectValues" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sla": { "type": "integer", "format": "int64", "x-go-name": "SLA" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "systemAssociatedTypes": { "type": "array", "items": { "type": "string" }, "x-go-name": "SystemAssociatedTypes" }, "template": { "type": "string", "x-go-name": "Template" }, "threshold": { "type": "number", "format": "double", "x-go-name": "Threshold" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "type": { "type": "string", "x-go-name": "Type" }, "unmapped": { "type": "boolean", "x-go-name": "Unmapped" }, "unsearchable": { "type": "boolean", "x-go-name": "UnSearchable" }, "useAsKpi": { "type": "boolean", "x-go-name": "UseAsKpi" }, "validatedError": { "type": "string", "x-go-name": "ValidatedError" }, "validationRegex": { "type": "string", "x-go-name": "ValidationRegex" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "x2_fields": { "type": "string", "x-go-name": "XSIAMFields" } }, "x-go-package": "github.com/demisto/server/domain" }, "FieldsAlias": { "type": "object", "title": "FieldsAlias ...", "properties": { "cliName": { "type": "string", "x-go-name": "CliName" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "GridColumn": { "type": "object", "title": "GridColumn ...", "properties": { "displayName": { "type": "string", "x-go-name": "DisplayName" }, "fieldCalcScript": { "type": "string", "x-go-name": "FieldCalcScript" }, "isDefault": { "type": "boolean", "x-go-name": "IsDefault" }, "isReadOnly": { "type": "boolean", "x-go-name": "IsReadOnly" }, "key": { "type": "string", "x-go-name": "Key" }, "orgType": { "type": "string", "x-go-name": "OrgType" }, "required": { "type": "boolean", "x-go-name": "Required" }, "script": { "type": "string", "x-go-name": "Script" }, "selectValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SelectValues" }, "type": { "type": "string", "x-go-name": "Type" }, "width": { "type": "integer", "format": "int64", "x-go-name": "Width" } }, "x-go-package": "github.com/demisto/server/domain" }, "FieldGroup": { "type": "number", "description": "FieldGroup is the field group", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "FieldMergeStrategy": { "type": "string", "description": "FieldMergeStrategy strategy for merging of indicator fields", "x-go-package": "github.com/demisto/server/domain" }, "incidentFieldsWithErrors": { "type": "object", "properties": { "error": { "type": "string", "x-go-name": "Error" }, "incidentFields": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentField" }, "x-go-name": "IncidentFields" } }, "x-go-package": "github.com/demisto/server/web" }, "SearchIncidentsData": { "type": "object", "title": "SearchIncidentsData ...", "properties": { "filter": { "$ref": "#/components/schemas/IncidentFilter" }, "userFilter": { "type": "boolean", "x-go-name": "FilterByUser" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Incident": { "type": "object", "title": "Incident details.", "description": "An incident can be manually opened algorithmically or arrive from an external source like SIEM.\nNote: CustomFields (an optional generic object type) is missing from swagger properties definition.", "properties": { "ShardID": { "type": "integer", "format": "int64" }, "account": { "type": "string", "description": "Account holds the tenant name so that slicing and dicing on the master can leverage bleve", "x-go-name": "Account" }, "activated": { "type": "string", "description": "When was this activated", "format": "date-time", "x-go-name": "Activated" }, "activatingingUserId": { "type": "string", "description": "The user that activated this investigation", "x-go-name": "ActivatingUserID" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "attachment": { "type": "array", "description": "Attachments", "items": { "$ref": "#/components/schemas/Attachment" }, "x-go-name": "Attachments" }, "autime": { "type": "integer", "description": "AlmostUniqueTime is an attempt to have a unique sortable ID for an incident", "format": "int64", "x-go-name": "AlmostUniqueTime" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "canvases": { "type": "array", "description": "Canvases of the incident", "items": { "type": "string" }, "x-go-name": "Canvases" }, "category": { "type": "string", "description": "Category", "x-go-name": "Category" }, "closeNotes": { "type": "string", "description": "Notes for closing the incident", "x-go-name": "CloseNotes" }, "closeReason": { "type": "string", "description": "The reason for closing the incident (select from existing predefined values)", "x-go-name": "ArchiveReason" }, "closed": { "type": "string", "description": "When was this closed", "format": "date-time", "x-go-name": "Closed" }, "closingUserId": { "type": "string", "description": "The user ID that closed this investigation", "x-go-name": "ClosingUserID" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "dbotCurrentDirtyFields": { "type": "array", "description": "For mirroring, manage a list of current dirty fields so that we can send delta to outgoing integration", "items": { "type": "string" }, "x-go-name": "DBotCurrentDirtyFields" }, "dbotDirtyFields": { "type": "array", "description": "For mirroring, manage a list of dirty fields to not override them from the source of the incident", "items": { "type": "string" }, "x-go-name": "DBotDirtyFields" }, "dbotMirrorDirection": { "type": "string", "description": "DBotMirrorDirection of how to mirror the incident (in/out/both)", "x-go-name": "DBotMirrorDirection" }, "dbotMirrorId": { "type": "string", "description": "DBotMirrorID of a remote system we are syncing with", "x-go-name": "DBotMirrorID" }, "dbotMirrorInstance": { "type": "string", "description": "DBotMirrorInstance name of a mirror integration instance", "x-go-name": "DBotMirrorInstance" }, "dbotMirrorLastSync": { "type": "string", "description": "The last time we synced this incident even if we did not update anything", "format": "date-time", "x-go-name": "DBotMirrorLastSync" }, "dbotMirrorTags": { "type": "array", "description": "The entry tags I want to sync to remote system", "items": { "type": "string" }, "x-go-name": "DBotMirrorEntryTags" }, "details": { "type": "string", "description": "The details of the incident - reason, etc.", "x-go-name": "Details" }, "droppedCount": { "type": "integer", "description": "DroppedCount ...", "format": "int64", "x-go-name": "DroppedCount" }, "dueDate": { "type": "string", "description": "SLA", "format": "date-time", "x-go-name": "DueDate" }, "feedBased": { "type": "boolean", "description": "If this incident was triggered by a feed job", "x-go-name": "FeedBased" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "investigationId": { "type": "string", "description": "Investigation that was opened as a result of the incoming event", "x-go-name": "Investigation" }, "isDebug": { "type": "boolean", "description": "IsDebug ...", "x-go-name": "IsDebug" }, "isPlayground": { "type": "boolean", "description": "IsPlayGround", "x-go-name": "IsPlayGround" }, "labels": { "type": "array", "description": "Labels related to incident - each label is composed of a type and value", "items": { "$ref": "#/components/schemas/Label" }, "x-go-name": "Labels" }, "lastJobRunTime": { "type": "string", "description": "If this incident was triggered by a job, this would be the time the **previous** job started", "format": "date-time", "x-go-name": "LastJobRunTime" }, "lastOpen": { "type": "string", "format": "date-time", "x-go-name": "LastOpen" }, "linkedCount": { "type": "integer", "description": "LinkedCount ...", "format": "int64", "x-go-name": "LinkedCount" }, "linkedIncidents": { "type": "array", "description": "LinkedIncidents incidents that were marked as linked by user", "items": { "type": "string" }, "x-go-name": "LinkedIncidents" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "description": "Incident Name - given by user", "x-go-name": "Name" }, "notifyTime": { "type": "string", "description": "Incdicates when last this field was changed with a value that supposed to send a notification", "format": "date-time", "x-go-name": "NotifyTime" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "occurred": { "type": "string", "description": "When this incident has really occurred", "format": "date-time", "x-go-name": "Occurred" }, "openDuration": { "type": "integer", "description": "Duration incident was open", "format": "int64", "x-go-name": "OpenDuration" }, "owner": { "type": "string", "description": "The user who owns this incident", "x-go-name": "OwnerID" }, "parent": { "type": "string", "description": "Parent", "x-go-name": "Parent" }, "phase": { "type": "string", "description": "Phase", "x-go-name": "Phase" }, "playbookId": { "type": "string", "description": "The associated playbook for this incident", "x-go-name": "PlaybookID" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "rawCategory": { "type": "string", "x-go-name": "RawCategory" }, "rawCloseReason": { "type": "string", "description": "The reason for closing the incident (select from existing predefined values)", "x-go-name": "RawArchiveReason" }, "rawJSON": { "type": "string", "x-go-name": "RawJSONData" }, "rawName": { "type": "string", "description": "Incident RawName", "x-go-name": "RawName" }, "rawPhase": { "type": "string", "description": "RawPhase", "x-go-name": "RawPhase" }, "rawType": { "type": "string", "description": "Incident raw type", "x-go-name": "RawType" }, "reason": { "type": "string", "description": "The reason for the resolve", "x-go-name": "Reason" }, "reminder": { "type": "string", "description": "When if at all to send a reminder", "format": "date-time", "x-go-name": "Reminder" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "runStatus": { "$ref": "#/components/schemas/RunStatus" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "severity": { "$ref": "#/components/schemas/Severity" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sla": { "$ref": "#/components/schemas/SLAState" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourceBrand": { "type": "string", "description": "SourceBrand ...", "x-go-name": "SourceBrand" }, "sourceInstance": { "type": "string", "description": "SourceInstance ...", "x-go-name": "SourceInstance" }, "status": { "$ref": "#/components/schemas/IncidentStatus" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "todoTaskIds": { "type": "array", "description": "ToDoTaskIDs list of to do task ids", "items": { "type": "string" }, "x-go-name": "ToDoTaskIDs" }, "type": { "type": "string", "description": "Incident type", "x-go-name": "Type" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "IncidentType": { "type": "object", "title": "IncidentType ...", "properties": { "autorun": { "type": "boolean", "x-go-name": "IsAutoRun" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "closureScript": { "type": "string", "x-go-name": "ClosureScript" }, "color": { "type": "string", "x-go-name": "Color" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "days": { "type": "integer", "format": "int64", "x-go-name": "Days" }, "daysR": { "type": "integer", "format": "int64", "x-go-name": "DaysReminder" }, "default": { "type": "boolean", "x-go-name": "IsDefaultType" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "detached": { "type": "boolean", "x-go-name": "Detached" }, "disabled": { "type": "boolean", "x-go-name": "Disabled" }, "extractSettings": { "$ref": "#/components/schemas/IncidentTypeExtractSettings" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "hours": { "type": "integer", "format": "int64", "x-go-name": "Hours" }, "hoursR": { "type": "integer", "format": "int64", "x-go-name": "HoursReminder" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "layout": { "type": "string", "x-go-name": "Layout" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "onChangeRepAlg": { "$ref": "#/components/schemas/ReputationCalcAlg" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "playbookId": { "type": "string", "x-go-name": "PlaybookID" }, "preProcessingScript": { "type": "string", "x-go-name": "PreProcessingScript" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "readonly": { "type": "boolean", "x-go-name": "ReadOnly" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "reputationCalc": { "$ref": "#/components/schemas/ReputationCalcAlg" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sla": { "type": "integer", "format": "int64", "x-go-name": "SLA" }, "slaReminder": { "type": "integer", "format": "int64", "x-go-name": "SLAReminder" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "weeks": { "type": "integer", "format": "int64", "x-go-name": "Weeks" }, "weeksR": { "type": "integer", "format": "int64", "x-go-name": "WeeksReminder" } }, "x-go-package": "github.com/demisto/server/domain" }, "IncidentTypeExtractSettings": { "type": "object", "title": "IncidentTypeExtractSettings ...", "properties": { "fieldCliNameToExtractSettings": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FieldExtractSetting" }, "x-go-name": "FieldCliNameToExtractSettings" }, "mode": { "$ref": "#/components/schemas/ExtractSettingsMode" } }, "x-go-package": "github.com/demisto/server/domain" }, "FieldExtractSetting": { "type": "object", "title": "FieldExtractSetting ...", "properties": { "extractAsIsIndicatorTypeId": { "type": "string", "x-go-name": "ExtractAsIsIndicatorTypeID" }, "extractIndicatorTypesIDs": { "type": "array", "items": { "type": "string" }, "x-go-name": "ExtractIndicatorTypesIDs" }, "isExtractingAllIndicatorTypes": { "type": "boolean", "x-go-name": "IsExtractingAllIndicatorTypes" } }, "x-go-package": "github.com/demisto/server/domain" }, "ExtractSettingsMode": { "type": "string", "title": "ExtractSettingsMode ...", "x-go-package": "github.com/demisto/server/domain" }, "ReputationCalcAlg": { "type": "number", "title": "ReputationCalcAlg ...", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "incidentTypesWithErrors": { "type": "object", "properties": { "error": { "type": "string", "x-go-name": "Error" }, "incidentTypes": { "type": "array", "items": { "$ref": "#/components/schemas/IncidentType" }, "x-go-name": "IncidentTypes" } }, "x-go-package": "github.com/demisto/server/web" }, "indicatorContext": { "type": "object", "properties": { "entryId": { "type": "string", "x-go-name": "EntryID" }, "indicator": { "$ref": "#/components/schemas/IocObject" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" }, "manually": { "type": "boolean", "x-go-name": "Manually" }, "seenNow": { "type": "boolean", "x-go-name": "SeenNow" } }, "x-go-package": "github.com/demisto/server/web" }, "IocObject": { "type": "object", "description": "IocObject - represents an Ioc (or simply an indicator) object", "properties": { "CustomFields": { "$ref": "#/components/schemas/CustomFields" }, "account": { "type": "string", "x-go-name": "Account" }, "aggregatedReliability": { "type": "string", "x-go-name": "AggregatedReliability" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "calculatedTime": { "type": "string", "description": "Do not set the fields bellow this line", "format": "date-time", "x-go-name": "CalculatedTime" }, "comment": { "type": "string", "x-go-name": "Comment" }, "comments": { "$ref": "#/components/schemas/Comments" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "deletedFeedFetchTime": { "type": "string", "format": "date-time", "x-go-name": "DeletedFeedFetchTime" }, "expiration": { "type": "string", "format": "date-time", "x-go-name": "ExpirationTime" }, "expirationSource": { "$ref": "#/components/schemas/ExpirationSource" }, "expirationStatus": { "$ref": "#/components/schemas/ExpirationStatus" }, "firstSeen": { "type": "string", "format": "date-time", "x-go-name": "FirstSeen" }, "firstSeenEntryID": { "type": "string", "x-go-name": "FirstSeenEntryID" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "indicator_type": { "type": "string", "x-go-name": "Type" }, "insightCache": { "$ref": "#/components/schemas/InsightCache" }, "investigationIDs": { "type": "array", "items": { "type": "string" }, "x-go-name": "InvestigationIDs" }, "isDetectable": { "type": "boolean", "x-go-name": "IsDetectable" }, "isPreventable": { "type": "boolean", "x-go-name": "IsPreventable" }, "isShared": { "type": "boolean", "x-go-name": "IsShared" }, "lastReputationRun": { "type": "string", "format": "date-time", "x-go-name": "LastReputationRun" }, "lastSeen": { "type": "string", "format": "date-time", "x-go-name": "LastSeen" }, "lastSeenEntryID": { "type": "string", "x-go-name": "LastSeenEntryID" }, "manualExpirationTime": { "type": "string", "format": "date-time", "x-go-name": "ManualExpirationTime" }, "manualScore": { "type": "boolean", "x-go-name": "ManualScore" }, "manualSetTime": { "type": "string", "format": "date-time", "x-go-name": "ManualSetTime" }, "manuallyEditedFields": { "type": "array", "items": { "type": "string" }, "x-go-name": "ManuallyEditedFields" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "modifiedTime": { "type": "string", "format": "date-time", "x-go-name": "ModifiedTime" }, "moduleToFeedMap": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FeedIndicator" }, "x-go-name": "ModuleToFeedMap" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "relatedIncCount": { "type": "integer", "format": "int64", "x-go-name": "RelatedIncCount" }, "score": { "type": "integer", "format": "int64", "x-go-name": "Score" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "setBy": { "type": "string", "x-go-name": "SetBy" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "source": { "type": "string", "x-go-name": "Source" }, "sourceBrands": { "type": "array", "items": { "type": "string" }, "x-go-name": "SourceBrands" }, "sourceInstances": { "type": "array", "items": { "type": "string" }, "x-go-name": "SourceInstances" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "timestamp": { "type": "string", "format": "date-time", "x-go-name": "TimeStamp" }, "value": { "type": "string", "x-go-name": "Value" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "Comments": { "type": "array", "title": "Comments ...", "items": { "$ref": "#/components/schemas/Comment" }, "x-go-package": "github.com/demisto/server/domain" }, "Comment": { "type": "object", "title": "Comment ...", "properties": { "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "category": { "type": "string", "x-go-name": "Category" }, "content": { "type": "string", "x-go-name": "Content" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "entryId": { "type": "string", "x-go-name": "EntryID" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "source": { "type": "string", "x-go-name": "Source" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "type": { "$ref": "#/components/schemas/CommentType" }, "user": { "type": "string", "x-go-name": "User" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "CommentType": { "type": "string", "title": "CommentType - comment type: regular comment, time-line, etc...", "x-go-package": "github.com/demisto/server/domain" }, "ExpirationStatus": { "type": "string", "title": "ExpirationStatus ...", "x-go-package": "github.com/demisto/server/domain" }, "InsightCache": { "type": "object", "description": "InsightCache - map insight name to all its metadata, name will be case insensitive", "properties": { "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "scores": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DBotScore" }, "x-go-name": "Scores" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "DBotScore": { "type": "object", "description": "DBotScore - Contain the score of a specific brand for a specific insight", "properties": { "content": { "type": "string", "x-go-name": "Content" }, "contentFormat": { "type": "string", "x-go-name": "ContentFormat" }, "context": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Context" }, "isTypedIndicator": { "type": "boolean", "x-go-name": "IsTypedIndicator" }, "reliability": { "type": "string", "x-go-name": "SourceReliability" }, "score": { "type": "integer", "format": "int64", "x-go-name": "Score" }, "scoreChangeTimestamp": { "type": "string", "description": "We need to track when the score changes to know if we need to re-calculate the overall score", "format": "date-time", "x-go-name": "ScoreChangeTimeStamp" }, "timestamp": { "type": "string", "format": "date-time", "x-go-name": "TimeStamp" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "updateIndicatorReputationData": { "type": "object", "properties": { "InvestigationId": { "type": "string", "x-go-name": "InvID" }, "doNotWhitelist": { "type": "boolean", "x-go-name": "DoNotWhitelist" }, "entryId": { "type": "string", "x-go-name": "EntryID" }, "manualScore": { "type": "boolean", "x-go-name": "ManualScore" }, "reason": { "type": "string", "x-go-name": "Reason" }, "reputation": { "type": "integer", "format": "int64", "x-go-name": "Reputation" }, "reputations": { "type": "array", "items": { "type": "string" }, "x-go-name": "Reputations" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "github.com/demisto/server/web" }, "UpdateResponse": { "type": "object", "title": "UpdateResponse ...", "properties": { "notUpdated": { "type": "integer", "format": "int64", "x-go-name": "NotUpdated" }, "updatedIds": { "type": "array", "items": { "type": "string" }, "x-go-name": "UpdatedIds" }, "uppdated": { "type": "integer", "format": "int64", "x-go-name": "Updated" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "genericIndicatorUpdateBatch": { "type": "object", "properties": { "all": { "type": "boolean", "x-go-name": "All" }, "columns": { "type": "array", "items": { "type": "string" }, "x-go-name": "Columns" }, "doNotWhitelist": { "type": "boolean", "x-go-name": "DoNotWhitelist" }, "filter": { "$ref": "#/components/schemas/IndicatorFilter" }, "ids": { "type": "array", "items": { "type": "string" }, "x-go-name": "IDs" }, "reason": { "type": "string", "x-go-name": "Reason" }, "reputations": { "type": "array", "items": { "type": "string" }, "x-go-name": "Reputations" } }, "x-go-package": "github.com/demisto/server/web" }, "IndicatorFilter": { "type": "object", "description": "IndicatorFilter is a general filter that fetches entities using a query string query using the Query value", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "accounts": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "earlyTimeInPage": { "type": "string", "format": "date-time", "x-go-name": "EarlyTimeInPage" }, "fields": { "type": "array", "items": { "type": "string" }, "x-go-name": "Fields" }, "filterobjectquery": { "type": "string", "x-go-name": "FilterObjectQuery" }, "firstSeen": { "$ref": "#/components/schemas/DateRangeFilter" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "lastSeen": { "$ref": "#/components/schemas/DateRangeFilter" }, "laterTimeInPage": { "type": "string", "format": "date-time", "x-go-name": "LaterTimeInPage" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "period": { "$ref": "#/components/schemas/Period" }, "prevPage": { "type": "boolean", "description": "MT support - these fields are for indicator search according to calculatedTime", "x-go-name": "PrevPage" }, "query": { "type": "string", "x-go-name": "Query" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "trim_events": { "type": "integer", "format": "int64", "x-go-name": "TrimEvents" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "DateRangeFilter": { "type": "object", "description": "DateRangeFilter provides common fields for date filtering", "properties": { "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "period": { "$ref": "#/components/schemas/Period" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "FeedIndicatorsRequest": { "type": "object", "description": "FeedIndicatorsRequest is the input for JSON feed indicator ingestion", "properties": { "bypassExclusionList": { "type": "boolean", "x-go-name": "ShouldBypassExclusionList" }, "classifierId": { "type": "string", "x-go-name": "ClassifierID" }, "indicators": { "type": "array", "items": { "$ref": "#/components/schemas/RawFeedIndicator" }, "x-go-name": "Indicators" }, "mapperId": { "type": "string", "x-go-name": "MapperID" } }, "x-go-package": "github.com/demisto/server/web" }, "RawFeedIndicator": { "type": "object", "description": "RawFeedIndicator is an unparsed feed indicator from JSON ingestion", "additionalProperties": { "type": "object" }, "x-go-package": "github.com/demisto/server/web" }, "IndicatorResult": { "type": "object", "title": "IndicatorResult ...", "properties": { "accountErrors": { "type": "array", "items": { "type": "string" }, "x-go-name": "AccountErrors" }, "iocObjects": { "$ref": "#/components/schemas/IocObjects" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" }, "totalAccounts": { "type": "integer", "format": "int64", "x-go-name": "TotalAccounts" } }, "x-go-package": "github.com/demisto/server/web" }, "IocObjects": { "type": "array", "title": "IocObjects ...", "items": { "$ref": "#/components/schemas/IocObject" }, "x-go-package": "github.com/demisto/server/domain" }, "IndicatorEditBulkResponse": { "type": "object", "title": "IndicatorEditBulkResponse ...", "properties": { "total": { "type": "integer", "format": "uint64", "x-go-name": "Total" }, "updated": { "type": "integer", "format": "uint64", "x-go-name": "Updated" } }, "x-go-package": "github.com/demisto/server/web" }, "WhitelistedIndicator": { "type": "object", "description": "WhitelistedIndicator Excluded indicator", "properties": { "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "reason": { "type": "string", "x-go-name": "Reason" }, "reputations": { "type": "array", "items": { "type": "string" }, "x-go-name": "Reputations" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "type": { "type": "string", "x-go-name": "Type" }, "user": { "type": "string", "x-go-name": "User" }, "value": { "type": "string", "x-go-name": "Value" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "whitelistTime": { "type": "string", "format": "date-time", "x-go-name": "WhitelistTime" } }, "x-go-package": "github.com/demisto/server/domain" }, "InvPlaybookTaskData": { "type": "object", "title": "InvPlaybookTaskData ...", "properties": { "addAfter": { "type": "boolean", "x-go-name": "AddAfter" }, "addToSeparateBranch": { "type": "boolean", "x-go-name": "AddToSeparateBranch" }, "automationScript": { "type": "string", "x-go-name": "AutomationScript" }, "description": { "type": "string", "x-go-name": "Description" }, "loop": { "$ref": "#/components/schemas/TaskLoop" }, "name": { "type": "string", "x-go-name": "Name" }, "neighborInvPBTaskId": { "type": "string", "x-go-name": "NeighborInvPBTaskID" }, "playbookId": { "type": "string", "x-go-name": "PlaybookID" }, "scriptArguments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "ScriptArguments" }, "separateContext": { "type": "boolean", "x-go-name": "SeparateContext" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "type": { "$ref": "#/components/schemas/TaskType" } }, "x-go-package": "github.com/demisto/server/services" }, "TaskLoop": { "type": "object", "description": "TaskLoop contains loop details", "properties": { "brand": { "type": "string", "x-go-name": "Brand" }, "builtinCondition": { "type": "array", "items": { "$ref": "#/components/schemas/ArgFilter" }, "x-go-name": "BuiltInCondition" }, "exitCondition": { "type": "string", "x-go-name": "ExitCondition" }, "forEach": { "type": "boolean", "x-go-name": "ForEach" }, "isCommand": { "type": "boolean", "x-go-name": "IsCommand" }, "max": { "type": "integer", "format": "int64", "x-go-name": "MaxIterations" }, "scriptArguments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "ScriptArguments" }, "scriptId": { "type": "string", "x-go-name": "AutomationScriptID" }, "scriptName": { "type": "string", "x-go-name": "AutomationScriptName" }, "wait": { "type": "integer", "format": "int64", "x-go-name": "WaitBetweenIterations" } }, "x-go-package": "github.com/demisto/server/domain" }, "TaskType": { "type": "string", "description": "TaskType is the Task in the playbook context as a node", "x-go-package": "github.com/demisto/server/domain" }, "InvestigationPlaybook": { "type": "object", "description": "InvestigationPlaybook is a wrapper for a linked list of Playbook tasks", "properties": { "Dirty": { "type": "boolean" }, "ReadyPlaybookInputs": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object" } } }, "ReplacedPlaybook": { "type": "boolean", "description": "Indicate whether this playbook has new history during this session" }, "ShardID": { "type": "integer", "format": "int64" }, "UpdatedOperatorIDs": { "type": "boolean" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "autoExtracting": { "type": "boolean", "x-go-name": "AutoExtracting" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "comment": { "type": "string", "x-go-name": "Description" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "incidentCreateDate": { "type": "string", "description": "Incident create date", "format": "date-time", "x-go-name": "IncidentCreateDate" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "inputs": { "$ref": "#/components/schemas/PlaybookInputs" }, "invPBDebugInfo": { "$ref": "#/components/schemas/InvPlaybookDebugInfo" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" }, "isTIM": { "type": "boolean", "x-go-name": "IsTIM" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "outputs": { "$ref": "#/components/schemas/PlaybookOutputs" }, "pbHistory": { "type": "array", "description": "in: body", "items": { "$ref": "#/components/schemas/InvestigationPlaybookData" }, "x-go-name": "PbHistory" }, "pendingTasks": { "type": "object", "description": "Tasks that are marked for running, but cannot yet run due to incomplete parents", "additionalProperties": { "type": "object" }, "x-go-name": "PendingTasks" }, "playbookId": { "type": "string", "x-go-name": "PlaybookID" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "quiet": { "type": "boolean", "x-go-name": "Quiet" }, "recoveryAttempts": { "type": "integer", "format": "int64", "x-go-name": "RecoveryAttempts" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "serverId": { "type": "string", "description": "Holds the ID of the responsible cluster app server", "x-go-name": "ServerID" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "startDate": { "type": "string", "format": "date-time", "x-go-name": "StartDate" }, "startTaskId": { "type": "string", "description": "FirstTask is the root task of the playbook", "x-go-name": "StartTaskID" }, "state": { "$ref": "#/components/schemas/InvestigationPlaybookState" }, "subPlaybookInputs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlaybookInputs" }, "x-go-name": "SubPlaybookInputs" }, "subPlaybookOutputs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlaybookOutputs" }, "x-go-name": "SubPlaybookOutputs" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "tasks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/InvestigationPlaybookTask" }, "x-go-name": "Tasks" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "view": { "$ref": "#/components/schemas/PlaybookView" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "PlaybookInputs": { "type": "array", "description": "PlaybookInputs - array of PlaybookInput", "items": { "$ref": "#/components/schemas/PlaybookInput" }, "x-go-package": "github.com/demisto/server/domain" }, "PlaybookInput": { "type": "object", "description": "PlaybookInput represents the playbook input", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "key": { "type": "string", "x-go-name": "Key" }, "playbookInputQuery": { "$ref": "#/components/schemas/PlaybookInputQuery" }, "required": { "type": "boolean", "x-go-name": "Required" }, "value": { "$ref": "#/components/schemas/AdvanceArg" } }, "x-go-package": "github.com/demisto/server/domain" }, "PlaybookInputQuery": { "type": "object", "description": "PlaybookInputQuery represents the playbook query input", "properties": { "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "period": { "$ref": "#/components/schemas/Period" }, "query": { "type": "string", "x-go-name": "Query" }, "queryEntity": { "type": "string", "x-go-name": "QueryEntity" }, "queryState": { "$ref": "#/components/schemas/QueryState" }, "results": { "type": "object", "x-go-name": "Results" }, "runFromLastJobTime": { "type": "boolean", "x-go-name": "RunFromLastJobTime" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" } }, "x-go-package": "github.com/demisto/server/domain" }, "QueryState": { "type": "object", "description": "QueryState represents the playbook query state", "properties": { "batchSize": { "type": "integer", "format": "int64", "x-go-name": "BatchSize" }, "currentPage": { "type": "integer", "format": "int64", "x-go-name": "CurrentPage" }, "searchAfter": { "type": "array", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "totalResults": { "type": "integer", "format": "int64", "x-go-name": "TotalResults" } }, "x-go-package": "github.com/demisto/server/domain" }, "InvPlaybookDebugInfo": { "type": "object", "title": "InvPlaybookDebugInfo ...", "properties": { "originalInvPBId": { "type": "string", "x-go-name": "OriginalInvPBID" } }, "x-go-package": "github.com/demisto/server/domain" }, "PlaybookOutputs": { "type": "array", "description": "PlaybookOutputs - array of PlaybookOutput", "items": { "$ref": "#/components/schemas/PlaybookOutput" }, "x-go-package": "github.com/demisto/server/domain" }, "PlaybookOutput": { "type": "object", "description": "PlaybookOutput represents the playbook output", "properties": { "contextPath": { "type": "string", "x-go-name": "ContextPath" }, "description": { "type": "string", "x-go-name": "Description" }, "type": { "$ref": "#/components/schemas/OutputType" } }, "x-go-package": "github.com/demisto/server/domain" }, "InvestigationPlaybookData": { "type": "object", "description": "InvestigationPlaybookData returns all data of an investigation playbook, not including history", "properties": { "ReadyPlaybookInputs": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "object" } } }, "autoExtracting": { "type": "boolean", "x-go-name": "AutoExtracting" }, "comment": { "type": "string", "x-go-name": "Description" }, "inputs": { "$ref": "#/components/schemas/PlaybookInputs" }, "investigationId": { "type": "string", "x-go-name": "InvestigationID" }, "isTIM": { "type": "boolean", "x-go-name": "IsTIM" }, "name": { "type": "string", "x-go-name": "Name" }, "outputs": { "$ref": "#/components/schemas/PlaybookOutputs" }, "pendingTasks": { "type": "object", "description": "Tasks that are marked for running, but cannot yet run due to incomplete parents", "additionalProperties": { "type": "object" }, "x-go-name": "PendingTasks" }, "playbookId": { "type": "string", "x-go-name": "PlaybookID" }, "quiet": { "type": "boolean", "x-go-name": "Quiet" }, "startDate": { "type": "string", "format": "date-time", "x-go-name": "StartDate" }, "startTaskId": { "type": "string", "description": "FirstTask is the root task of the playbook", "x-go-name": "StartTaskID" }, "state": { "$ref": "#/components/schemas/InvestigationPlaybookState" }, "subPlaybookInputs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlaybookInputs" }, "x-go-name": "SubPlaybookInputs" }, "subPlaybookOutputs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlaybookOutputs" }, "x-go-name": "SubPlaybookOutputs" }, "tasks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/InvestigationPlaybookTask" }, "x-go-name": "Tasks" }, "view": { "$ref": "#/components/schemas/PlaybookView" } }, "x-go-package": "github.com/demisto/server/domain" }, "InvestigationPlaybookState": { "type": "string", "description": "InvestigationPlaybookState indicates the state of the running playbook", "x-go-package": "github.com/demisto/server/domain" }, "InvestigationPlaybookTask": { "type": "object", "description": "InvestigationPlaybookTask is the Task in the playbook context as a node", "properties": { "Reopen": { "type": "boolean" }, "arguments": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Arguments" }, "assignee": { "type": "string", "x-go-name": "Assignee" }, "assigneeSet": { "type": "boolean", "x-go-name": "AssigneeSet" }, "blockingTasks": { "type": "array", "items": { "type": "string" }, "x-go-name": "BlockingTasks" }, "calculatedDescription": { "type": "string", "x-go-name": "CalculatedDescription" }, "calculatedTaskName": { "type": "string", "x-go-name": "CalculatedTaskName" }, "comments": { "type": "boolean", "description": "Whether this task had any comments or not", "x-go-name": "Comments" }, "completedBy": { "type": "string", "x-go-name": "CompletedBy" }, "completedCount": { "type": "integer", "format": "int64", "x-go-name": "CompletedCount" }, "completedDate": { "type": "string", "format": "date-time", "x-go-name": "CompletedDate" }, "conditions": { "type": "array", "description": "Conditions - optional list of conditions to run when task is conditional. we check conditions by their order (e.i. - considering the first one that satisfied)", "items": { "$ref": "#/components/schemas/TaskCondition" }, "x-go-name": "Conditions" }, "continueOnError": { "type": "boolean", "x-go-name": "ContinueOnError" }, "continueOnErrorType": { "$ref": "#/components/schemas/ContinueOnErrorType" }, "defaultAssignee": { "type": "string", "x-go-name": "DefaultAssignee" }, "defaultAssigneeComplex": { "$ref": "#/components/schemas/AdvanceArg" }, "defaultReminder": { "type": "integer", "format": "int64", "x-go-name": "DefaultReminder" }, "doNotSaveTaskHistory": { "type": "boolean", "x-go-name": "DoNotSaveTaskHistory" }, "dueDate": { "type": "string", "format": "date-time", "x-go-name": "DueDate" }, "dueDateDuration": { "type": "integer", "format": "int64", "x-go-name": "DueDateDuration" }, "dueDateDurationUnit": { "$ref": "#/components/schemas/SLADurationUnit" }, "dueDateSet": { "type": "boolean", "x-go-name": "DueDateSet" }, "entries": { "type": "array", "items": { "type": "string" }, "x-go-name": "Entries" }, "evidenceData": { "$ref": "#/components/schemas/EvidenceData" }, "executionCount": { "type": "integer", "format": "int64", "x-go-name": "ExecutionCount" }, "externalFormUseAuth": { "type": "boolean", "x-go-name": "ExternalFormUseAuth" }, "fieldMapping": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMapping" }, "x-go-name": "FieldMappingArray" }, "forEachIndex": { "type": "integer", "description": "Parameters needed for loops", "format": "int64", "x-go-name": "ForEachIndex" }, "forEachInputs": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "object" } }, "x-go-name": "ForEachInputs" }, "form": { "$ref": "#/components/schemas/DataCollectionForm" }, "formDisplay": { "$ref": "#/components/schemas/FormDisplay" }, "hasErrorEntries": { "type": "boolean", "x-go-name": "CompletedWithErrorEntries" }, "id": { "type": "string", "x-go-name": "ID" }, "ignoreWorker": { "type": "boolean", "description": "Do not run this task in a worker", "x-go-name": "IgnoreWorker" }, "indent": { "type": "integer", "format": "int64", "x-go-name": "Indent" }, "input": { "type": "string", "x-go-name": "Input" }, "isAutoSwitchedToQuietMode": { "type": "boolean", "x-go-name": "IsAutoSwitchedToQuietMode" }, "isOverSize": { "type": "boolean", "x-go-name": "IsOverSize" }, "loop": { "$ref": "#/components/schemas/TaskLoop" }, "message": { "$ref": "#/components/schemas/NotifiableItem" }, "missingContentItem": { "type": "string", "description": "content item which caused task to skip", "x-go-name": "MissingContentItem" }, "nextPollingTime": { "type": "string", "description": "NextPollTime Time of the next scheduled command execution", "format": "date-time", "x-go-name": "NextPollTime" }, "nextTasks": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "NextTasks" }, "note": { "type": "boolean", "x-go-name": "Note" }, "outputs": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Outputs" }, "parentBlockCount": { "type": "integer", "description": "the number of tasks that are waiting on blocked in subplaybooks of this task", "format": "int64", "x-go-name": "ParentBlockCount" }, "parentPlaybookID": { "type": "string", "x-go-name": "ParentPlaybookTaskID" }, "patched": { "type": "boolean", "description": "Indicates whether this task was patched to InvPB and did not originally belong to the playbook", "x-go-name": "Patched" }, "playbookInputs": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "PlaybookInputs" }, "pollingEntries": { "type": "array", "description": "PollingEntryIDs IDs of entries that are still polling", "items": { "type": "string" }, "x-go-name": "PollingEntryIDs" }, "pollingTimeoutTime": { "type": "string", "format": "date-time", "x-go-name": "PollingTimeoutTime" }, "previousTasks": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "PreviousTasks" }, "quietMode": { "$ref": "#/components/schemas/QuietMode" }, "reminder": { "type": "integer", "description": "Duration in minutes, this field is not persisted here", "format": "int64", "x-go-name": "Reminder" }, "reputationCalc": { "$ref": "#/components/schemas/ReputationCalcAlg" }, "restrictedCompletion": { "type": "boolean", "x-go-name": "RestrictedCompletion" }, "scriptArguments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "ScriptArguments" }, "separateContext": { "type": "boolean", "x-go-name": "SeparateContext" }, "skip": { "type": "boolean", "description": "Skip - if true then this task will be skipped and all the tasks which comes after this task and depend on it\nwill skip (WillNotExecute)", "x-go-name": "Skip" }, "skipUnavailable": { "type": "boolean", "description": "SkipUnavailable if true then will check if automation exists, integration of that command is installed and\nactive or sub playbook exists in Demisto", "x-go-name": "SkipUnavailable" }, "sla": { "$ref": "#/components/schemas/SLA" }, "slaReminder": { "$ref": "#/components/schemas/SLA" }, "startDate": { "type": "string", "format": "date-time", "x-go-name": "StartDate" }, "startedExecutingHarmfulScript": { "type": "boolean", "x-go-name": "StartedExecutingHarmfulScript" }, "state": { "$ref": "#/components/schemas/TaskState" }, "subPlaybook": { "$ref": "#/components/schemas/InvestigationPlaybook" }, "task": { "$ref": "#/components/schemas/Task" }, "taskCompleteData": { "type": "array", "description": "History complete data", "items": { "$ref": "#/components/schemas/InvPlaybookTaskCompleteData" }, "x-go-name": "TaskCompleteData" }, "taskDebug": { "$ref": "#/components/schemas/InvTaskDebug" }, "taskId": { "type": "string", "x-go-name": "TaskID" }, "taskSize": { "type": "integer", "format": "int64", "x-go-name": "TaskSize" }, "timerTriggers": { "type": "array", "description": "SLA fields", "items": { "$ref": "#/components/schemas/TimerTrigger" }, "x-go-name": "TimerTriggers" }, "timesPolled": { "type": "integer", "format": "int64", "x-go-name": "TimesPolled" }, "type": { "$ref": "#/components/schemas/TaskType" }, "view": { "$ref": "#/components/schemas/TaskView" }, "willNotExecuteCount": { "type": "integer", "format": "int64", "x-go-name": "WillNotExecuteCount" }, "willNotExecuteReason": { "type": "string", "x-go-name": "WillNotExecuteReason" } }, "x-go-package": "github.com/demisto/server/domain" }, "TaskCondition": { "type": "object", "description": "TaskCondition - contains a condition and a corresponding label\nif the condition satisfied - its label is taken as the next task(s) input (e.i. the label on the edge)", "properties": { "condition": { "type": "array", "items": { "$ref": "#/components/schemas/ArgFilter" }, "x-go-name": "Condition" }, "label": { "type": "string", "x-go-name": "Label" } }, "x-go-package": "github.com/demisto/server/domain" }, "ContinueOnErrorType": { "type": "string", "title": "ContinueOnErrorType there are different ways to handle an error. Ignore the error and proceed or handle it with error path.", "x-go-package": "github.com/demisto/server/domain" }, "SLADurationUnit": { "type": "integer", "description": "SLADurationUnit is a helper to calculate if SLA in hours or minutes", "format": "int64", "x-go-package": "github.com/demisto/server/domain" }, "EvidenceData": { "type": "object", "description": "EvidenceData - all evidence properties to evaluate in task process", "properties": { "customFields": { "type": "object", "description": "This field must have empty json key", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "CustomFields" }, "description": { "$ref": "#/components/schemas/AdvanceArg" }, "occurred": { "$ref": "#/components/schemas/AdvanceArg" }, "tags": { "$ref": "#/components/schemas/AdvanceArg" } }, "x-go-package": "github.com/demisto/server/domain" }, "FieldMapping": { "type": "object", "description": "FieldMapping - Map a task output (complex or simple value) to an incident field", "properties": { "fieldId": { "type": "string", "x-go-name": "IncidentField" }, "output": { "$ref": "#/components/schemas/AdvanceArg" } }, "x-go-package": "github.com/demisto/server/domain" }, "DataCollectionForm": { "type": "object", "title": "DataCollectionForm - a data collection form with questions.", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "expired": { "type": "boolean", "x-go-name": "Expired" }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/Question" }, "x-go-name": "Questions" }, "sender": { "type": "string", "x-go-name": "Sender" }, "title": { "type": "string", "x-go-name": "Title" }, "totalAnswers": { "type": "integer", "format": "uint64", "x-go-name": "TotalAnswers" } }, "x-go-package": "github.com/demisto/server/domain" }, "Question": { "type": "object", "title": "Question - question for a form with a given type.", "properties": { "columns": { "type": "array", "items": { "$ref": "#/components/schemas/GridColumn" }, "x-go-name": "GridColumns" }, "defaultRows": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } }, "x-go-name": "DefaultRows" }, "fieldAssociated": { "type": "string", "x-go-name": "FieldAssociated" }, "id": { "type": "string", "x-go-name": "ID" }, "label": { "type": "string", "x-go-name": "Label" }, "labelArg": { "$ref": "#/components/schemas/AdvanceArg" }, "options": { "type": "array", "items": { "type": "string" }, "x-go-name": "Options" }, "optionsArg": { "type": "array", "items": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "OptionsArg" }, "placeholder": { "type": "string", "x-go-name": "Placeholder" }, "readOnly": { "type": "boolean", "x-go-name": "ReadOnly" }, "required": { "type": "boolean", "x-go-name": "Required" }, "tooltip": { "type": "string", "x-go-name": "Tooltip" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "FormDisplay": { "type": "object", "title": "FormDisplay - display options for communication/ask task (for both email and web forms).", "properties": { "bodyBackgroundColor": { "type": "string", "x-go-name": "BodyBackgroundColor" }, "bodyFontColor": { "type": "string", "x-go-name": "BodyFontColor" }, "headerBackgroundColor": { "type": "string", "x-go-name": "HeaderBackgroundColor" }, "headerFontColor": { "type": "string", "x-go-name": "HeaderFontColor" }, "isExternalRtl": { "type": "boolean", "x-go-name": "IsExternalRtl" }, "sender": { "type": "string", "x-go-name": "Sender" }, "submitButtonBackgroundColor": { "type": "string", "x-go-name": "SubmitButtonBackgroundColor" }, "submitButtonFontColor": { "type": "string", "x-go-name": "SubmitButtonFontColor" }, "submitText": { "type": "string", "x-go-name": "SubmitText" } }, "x-go-package": "github.com/demisto/server/domain" }, "NotifiableItem": { "type": "object", "title": "NotifiableItem ...", "properties": { "bcc": { "$ref": "#/components/schemas/AdvanceArg" }, "body": { "$ref": "#/components/schemas/AdvanceArg" }, "cc": { "$ref": "#/components/schemas/AdvanceArg" }, "defaultOption": { "type": "string", "x-go-name": "DefaultOption" }, "format": { "type": "string", "x-go-name": "Format" }, "methods": { "type": "array", "items": { "type": "string" }, "x-go-name": "Methods" }, "replyOptions": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReplyOptions" }, "subject": { "$ref": "#/components/schemas/AdvanceArg" }, "timings": { "$ref": "#/components/schemas/NotifyTimings" }, "to": { "$ref": "#/components/schemas/AdvanceArg" } }, "x-go-package": "github.com/demisto/server/domain" }, "NotifyTimings": { "type": "object", "title": "NotifyTimings - time control on notify items - retries max count and intervals.", "properties": { "completeAfterReplies": { "type": "integer", "format": "uint64", "x-go-name": "CompleteAfterReplies" }, "completeAfterSLA": { "type": "boolean", "x-go-name": "CompleteAfterSLA" }, "completeAfterV2": { "type": "boolean", "x-go-name": "CompleteAfterV2" }, "retriesCount": { "type": "integer", "format": "uint64", "x-go-name": "RetriesCount" }, "retriesInterval": { "type": "integer", "format": "uint64", "x-go-name": "RetriesInterval" } }, "x-go-package": "github.com/demisto/server/domain" }, "QuietMode": { "type": "integer", "description": "QuietMode quiet mode for playbook task", "format": "int64", "x-go-package": "github.com/demisto/server/domain" }, "SLA": { "type": "object", "title": "SLA ...", "properties": { "days": { "type": "integer", "format": "int64", "x-go-name": "Days" }, "hours": { "type": "integer", "format": "int64", "x-go-name": "Hours" }, "minutes": { "type": "integer", "format": "int64", "x-go-name": "Minutes" }, "weeks": { "type": "integer", "format": "int64", "x-go-name": "Weeks" } }, "x-go-package": "github.com/demisto/server/domain" }, "TaskState": { "type": "string", "description": "TaskState indicates the state of the task during the incident/investigation execution", "x-go-package": "github.com/demisto/server/domain" }, "Task": { "type": "object", "description": "Task is the basic task in the task repository that can be associated to an incident via playbook", "properties": { "brand": { "type": "string", "x-go-name": "Brand" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "clonedFrom": { "type": "string", "x-go-name": "ClonedFrom" }, "comment": { "type": "string", "x-go-name": "Comment" }, "conditions": { "type": "array", "items": { "type": "string" }, "x-go-name": "ConditionnKeys" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "description": { "type": "string", "x-go-name": "Description" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "isCommand": { "type": "boolean", "x-go-name": "IsCommand" }, "isLocked": { "type": "boolean", "x-go-name": "IsLocked" }, "isTitleTask": { "type": "boolean", "x-go-name": "IsTitleTask" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "playbookId": { "type": "string", "x-go-name": "PlaybookID" }, "playbookName": { "type": "string", "x-go-name": "PlaybookName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "scriptId": { "type": "string", "x-go-name": "AutomationScriptID" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "type": { "$ref": "#/components/schemas/TaskType" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "InvPlaybookTaskCompleteData": { "type": "object", "title": "InvPlaybookTaskCompleteData ...", "properties": { "arguments": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Arguments" }, "calculatedDescription": { "type": "string", "x-go-name": "CalculatedDescription" }, "calculatedTaskName": { "type": "string", "x-go-name": "CalculatedTaskName" }, "completedBy": { "type": "string", "x-go-name": "CompletedBy" }, "completedCount": { "type": "integer", "format": "int64", "x-go-name": "CompletedCount" }, "completedDate": { "type": "string", "format": "date-time", "x-go-name": "CompletedDate" }, "entries": { "type": "array", "items": { "type": "string" }, "x-go-name": "Entries" }, "hasErrorEntries": { "type": "boolean", "x-go-name": "CompletedWithErrorEntries" }, "input": { "type": "string", "x-go-name": "Input" }, "outputs": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Outputs" }, "playbookInputs": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "PlaybookInputs" }, "startDate": { "type": "string", "format": "date-time", "x-go-name": "StartDate" }, "state": { "$ref": "#/components/schemas/TaskState" }, "willNotExecuteCount": { "type": "integer", "format": "int64", "x-go-name": "WillNotExecuteCount" }, "willNotExecuteReason": { "type": "string", "x-go-name": "WillNotExecuteReason" } }, "x-go-package": "github.com/demisto/server/domain" }, "InvTaskDebug": { "type": "object", "title": "InvTaskDebug ...", "properties": { "breakpointCondition": { "$ref": "#/components/schemas/ArgFilter" }, "inputOverrides": { "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "InputOverrides" }, "isMarkedWithBreakpoint": { "type": "boolean", "x-go-name": "IsMarkedWithBreakpoint" }, "isMarkedWithSkip": { "type": "boolean", "x-go-name": "IsMarkedWithSkip" }, "outputOverrides": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "OutputOverrides" }, "shouldOverrideDebugInfo": { "type": "boolean", "x-go-name": "ShouldOverrideDebugInfo" }, "skipConditionOverrideTo": { "type": "string", "x-go-name": "SkipConditionOverrideTo" }, "taskOriginalId": { "type": "string", "x-go-name": "OriginalID" } }, "x-go-package": "github.com/demisto/server/domain" }, "TimerTrigger": { "type": "object", "title": "TimerTrigger ...", "properties": { "action": { "$ref": "#/components/schemas/TimerAction" }, "fieldName": { "type": "string", "x-go-name": "FieldName" } }, "x-go-package": "github.com/demisto/server/domain" }, "TimerAction": { "type": "string", "title": "TimerAction ...", "x-go-package": "github.com/demisto/server/domain" }, "TaskView": { "type": "object", "description": "TaskView represents the view in client of the tasks graph", "x-go-package": "github.com/demisto/server/domain" }, "PlaybookView": { "type": "object", "description": "PlaybookView represents the view in client of playbook graph", "x-go-package": "github.com/demisto/server/domain" }, "invPlaybookAssignee": { "type": "object", "properties": { "assignee": { "type": "string", "x-go-name": "Assignee" }, "inTaskID": { "type": "string", "x-go-name": "TaskID" }, "invId": { "type": "string", "x-go-name": "ID" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Version" } }, "x-go-package": "github.com/demisto/server/web" }, "invTaskInfo": { "type": "object", "properties": { "args": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "Args" }, "comment": { "type": "string", "x-go-name": "Comment" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/TaskCondition" }, "x-go-name": "Conditions" }, "inTaskID": { "type": "string", "x-go-name": "TaskID" }, "input": { "type": "string", "x-go-name": "Input" }, "invId": { "type": "string", "x-go-name": "ID" }, "loopArgs": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "LoopArgs" }, "loopCondition": { "type": "array", "items": { "$ref": "#/components/schemas/ArgFilter" }, "x-go-name": "LoopCondition" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Version" } }, "x-go-package": "github.com/demisto/server/web" }, "invPlaybookDue": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "x-go-name": "Date" }, "inTaskID": { "type": "string", "x-go-name": "TaskID" }, "invId": { "type": "string", "x-go-name": "ID" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Version" } }, "x-go-package": "github.com/demisto/server/web" }, "SearchInvestigationsData": { "type": "object", "title": "SearchInvestigationsData ...", "properties": { "filter": { "$ref": "#/components/schemas/InvestigationFilter" } }, "x-go-package": "github.com/demisto/server/web" }, "InvestigationFilter": { "type": "object", "title": "InvestigationFilter allows for very simple filtering.", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "andOp": { "type": "boolean", "x-go-name": "AndOp" }, "category": { "type": "array", "items": { "type": "string" }, "x-go-name": "Category" }, "fromCloseDate": { "type": "string", "format": "date-time", "x-go-name": "FromCloseDate" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "id": { "type": "array", "items": { "type": "string" }, "x-go-name": "ID" }, "idsOnly": { "type": "boolean", "x-go-name": "IdsOnly" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "includeChildInv": { "type": "boolean", "x-go-name": "IncludeChildInv" }, "name": { "type": "array", "items": { "type": "string" }, "x-go-name": "Name" }, "notCategory": { "type": "array", "items": { "type": "string" }, "x-go-name": "NotCategory" }, "notIDs": { "type": "array", "items": { "type": "string" }, "x-go-name": "NotIDs" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "period": { "$ref": "#/components/schemas/Period" }, "reason": { "type": "array", "items": { "type": "string" }, "x-go-name": "Reason" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/InvestigationStatus" }, "x-go-name": "Status" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toCloseDate": { "type": "string", "format": "date-time", "x-go-name": "ToCloseDate" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/InvestigationType" }, "x-go-name": "Type" }, "user": { "type": "array", "items": { "type": "string" }, "x-go-name": "User" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "InvestigationStatus": { "type": "number", "description": "InvestigationStatus is the status type", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "InvestigationType": { "type": "number", "title": "InvestigationType ...", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "InvestigationSearchResponse": { "type": "object", "description": "InvestigationSearchResponse returns the response from the investigation search", "properties": { "data": { "type": "array", "description": "in: body", "items": { "$ref": "#/components/schemas/Investigation" }, "x-go-name": "Data" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Investigation": { "type": "object", "title": "Investigation contains the investigation of a particular incident.", "description": "A special investigation called playground is created for each user-project combination and is a private space for the researcher to play in.", "properties": { "ShardID": { "type": "integer", "format": "int64" }, "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "category": { "type": "string", "description": "Category of the investigation", "x-go-name": "Category" }, "childInvestigations": { "type": "array", "description": "ChildInvestigations id's", "items": { "type": "string" }, "x-go-name": "ChildInvestigations" }, "closed": { "type": "string", "description": "When was this closed", "format": "date-time", "x-go-name": "Closed" }, "closingUserId": { "type": "string", "description": "The user ID that closed this investigation", "x-go-name": "ClosingUserID" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "creatingUserId": { "type": "string", "description": "The user ID that created this investigation", "x-go-name": "CreatingUserID" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "details": { "type": "string", "description": "User defined free text details", "x-go-name": "Details" }, "entitlements": { "type": "array", "description": "One time entitlements", "items": { "type": "string" }, "x-go-name": "Entitlements" }, "entryUsers": { "type": "array", "description": "EntryUsers", "items": { "type": "string" }, "x-go-name": "EntryUsers" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "highPriority": { "type": "boolean", "description": "HighPriority - tasks of this investigation should run in high priority", "x-go-name": "HighPriority" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "isChildInvestigation": { "type": "boolean", "description": "IsChildInvestigation", "x-go-name": "IsChildInvestigation" }, "isDebug": { "type": "boolean", "description": "IsDebug ...", "x-go-name": "IsDebug" }, "lastOpen": { "type": "string", "format": "date-time", "x-go-name": "LastOpen" }, "mirrorAutoClose": { "type": "object", "description": "MirrorAutoClose will tell us to close the Chat Module channel if we close investigation", "additionalProperties": { "type": "boolean" }, "x-go-name": "MirrorAutoClose" }, "mirrorTypes": { "type": "object", "description": "MirrorTypes holds info about mirror direction and message type to be mirrored\nmessage type can be either 'all' or 'chat'\ndirection can be either 'FromDemisto', 'ToDemisto' or 'Both' if this investigation is mirrored", "additionalProperties": { "type": "string" }, "x-go-name": "MirrorTypes" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "description": "The name of the investigation, which is unique to the project", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "openDuration": { "type": "integer", "description": "Duration from open to close time", "format": "int64", "x-go-name": "OpenDuration" }, "parentInvestigation": { "type": "string", "description": "ParentInvestigation - parent id, in case this is a child investigation of another investigation", "x-go-name": "ParentInvestigation" }, "persistentEntitlements": { "type": "object", "description": "Persistent entitlement per tag. Empty tag will also return an entitlement", "additionalProperties": { "type": "string" }, "x-go-name": "PersistentEntitlements" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "rawCategory": { "type": "string", "x-go-name": "RawCategory" }, "reason": { "type": "object", "description": "The reason for the status (resolve)", "additionalProperties": { "type": "string" }, "x-go-name": "Reason" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "runStatus": { "$ref": "#/components/schemas/RunStatus" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "slackMirrorAutoClose": { "type": "boolean", "description": "DEPRECATED - DeprecatedSlackMirrorAutoClose will tell us to close the Slack channel if we close investigation", "x-go-name": "DeprecatedSlackMirrorAutoClose" }, "slackMirrorType": { "type": "string", "description": "DEPRECATED - DeprecatedSlackMirrorType holds info about mirror direction and message type to be mirror\nmessage type can be either 'all' or 'chat'\ndirection can be either 'demisto2Slack', 'slack2Demisto' or 'both' if this investigation is mirrored to Slack", "x-go-name": "DeprecatedSlackMirrorType" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "status": { "$ref": "#/components/schemas/InvestigationStatus" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "systems": { "type": "array", "description": "The systems involved", "items": { "$ref": "#/components/schemas/System" }, "x-go-name": "Systems" }, "tags": { "type": "array", "description": "Tags", "items": { "type": "string" }, "x-go-name": "Tags" }, "type": { "$ref": "#/components/schemas/InvestigationType" }, "users": { "type": "array", "description": "The users who share this investigation", "items": { "type": "string" }, "x-go-name": "Users" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "System": { "type": "object", "description": "System - URL stands for ip or hostname", "properties": { "agent": { "$ref": "#/components/schemas/SystemAgent" }, "arch": { "type": "string", "x-go-name": "Arch" }, "ciphers": { "type": "array", "items": { "type": "string" }, "x-go-name": "Ciphers" }, "credentials": { "type": "string", "x-go-name": "CredentialsName" }, "engineId": { "type": "string", "x-go-name": "EngineID" }, "host": { "type": "string", "x-go-name": "Host" }, "integrationinstanceid": { "type": "string", "x-go-name": "IntegrationInstanceID" }, "issharedagent": { "type": "boolean", "x-go-name": "IsSharedAgent" }, "name": { "type": "string", "x-go-name": "Name" }, "os": { "type": "string", "x-go-name": "OS" }, "password": { "type": "string", "x-go-name": "Password" }, "servicesID": { "type": "string", "x-go-name": "ServicesID" }, "smb": { "type": "integer", "format": "int64", "x-go-name": "SMBv" }, "smbport": { "type": "integer", "format": "uint16", "x-go-name": "SMBPort" }, "sshkey": { "type": "string", "x-go-name": "SSHKey" }, "sshport": { "type": "integer", "format": "uint16", "x-go-name": "SSHPort" }, "terminalOptions": { "$ref": "#/components/schemas/TerminalOptions" }, "user": { "type": "string", "x-go-name": "User" }, "workgroup": { "type": "string", "x-go-name": "Workgroup" } }, "x-go-package": "github.com/demisto/server/domain" }, "SystemAgent": { "type": "object", "description": "SystemAgent - represents agent status and holds server context", "properties": { "servercontext": { "type": "array", "items": { "type": "integer", "format": "uint8" }, "x-go-name": "ServerContext" } }, "x-go-package": "github.com/demisto/server/domain" }, "TerminalOptions": { "type": "object", "description": "TerminalOptions - terminal options to use in case of using pty", "properties": { "Echo": { "type": "integer", "format": "uint32" }, "Terminal": { "type": "boolean" }, "TerminalHeight": { "type": "integer", "format": "int64" }, "TerminalType": { "type": "string" }, "TerminalWidth": { "type": "integer", "format": "int64" }, "TyISpeed": { "type": "integer", "format": "uint32" }, "TyOSpeed": { "type": "integer", "format": "uint32" } }, "x-go-package": "github.com/demisto/server/domain" }, "playbookWithWarnings": { "type": "object", "properties": { "playbook": { "$ref": "#/components/schemas/Playbook" }, "warnings": { "type": "array", "items": { "type": "string" }, "x-go-name": "Warnings" } }, "x-go-package": "github.com/demisto/server/web" }, "Playbook": { "type": "object", "description": "Playbook is a collection of tasks", "properties": { "allRead": { "type": "boolean", "x-go-name": "IsAllRead" }, "allReadWrite": { "type": "boolean", "x-go-name": "IsAllReadWrite" }, "brands": { "type": "array", "items": { "type": "string" }, "x-go-name": "Brands" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "commands": { "type": "array", "items": { "type": "string" }, "x-go-name": "Commands" }, "comment": { "type": "string", "x-go-name": "Description" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "dbotCreatedBy": { "type": "string", "description": "Who has created this event - relevant only for manual incidents", "x-go-name": "CreatedBy" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "detached": { "type": "boolean", "x-go-name": "Detached" }, "encTasks": { "type": "string", "x-go-name": "EncTasks" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "hasRole": { "type": "boolean", "description": "Internal field to make queries on role faster", "x-go-name": "HasRole" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "inputs": { "$ref": "#/components/schemas/PlaybookInputs" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "missingScriptsIds": { "type": "array", "items": { "type": "string" }, "x-go-name": "MissingScriptsIDs" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "nameRaw": { "type": "string", "x-go-name": "NameRaw" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "outputs": { "$ref": "#/components/schemas/PlaybookOutputs" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "previousAllRead": { "type": "boolean", "x-go-name": "PreviousAllRead" }, "previousAllReadWrite": { "type": "boolean", "x-go-name": "PreviousAllReadWrite" }, "previousRoles": { "type": "array", "description": "Do not change this field manually", "items": { "type": "string" }, "x-go-name": "PreviousRoleName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "private": { "type": "boolean", "x-go-name": "Private" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "quiet": { "type": "boolean", "x-go-name": "Quiet" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "roles": { "type": "array", "description": "The role assigned to this investigation", "items": { "type": "string" }, "x-go-name": "RoleName" }, "scriptIds": { "type": "array", "items": { "type": "string" }, "x-go-name": "ScriptIDs" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourcePlaybookID": { "type": "string", "x-go-name": "SourcePlaybookID" }, "startTaskId": { "type": "string", "x-go-name": "StartTaskID" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "taskIds": { "type": "array", "description": "auto generated field that will contain all task ids in this playbook\nNeeded for searching with bleve", "items": { "type": "string" }, "x-go-name": "TaskIDs" }, "tasks": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PlaybookTask" }, "x-go-name": "Tasks" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "view": { "$ref": "#/components/schemas/PlaybookView" }, "xsoarHasReadOnlyRole": { "type": "boolean", "x-go-name": "HasReadOnlyRole" }, "xsoarPreviousReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "PreviousReadOnlyRoleName" }, "xsoarReadOnlyRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "ReadOnlyRoleName" } }, "x-go-package": "github.com/demisto/server/domain" }, "PlaybookTask": { "type": "object", "title": "PlaybookTask ...", "properties": { "conditions": { "type": "array", "description": "Conditions - optional list of conditions to run when task is conditional. we check conditions by their order (e.i. - considering the first one that satisfied)", "items": { "$ref": "#/components/schemas/TaskCondition" }, "x-go-name": "Conditions" }, "continueOnError": { "type": "boolean", "x-go-name": "ContinueOnError" }, "continueOnErrorType": { "$ref": "#/components/schemas/ContinueOnErrorType" }, "defaultAssignee": { "type": "string", "x-go-name": "DefaultAssignee" }, "defaultAssigneeComplex": { "$ref": "#/components/schemas/AdvanceArg" }, "defaultReminder": { "type": "integer", "format": "int64", "x-go-name": "DefaultReminder" }, "evidenceData": { "$ref": "#/components/schemas/EvidenceData" }, "externalFormUseAuth": { "type": "boolean", "x-go-name": "ExternalFormUseAuth" }, "fieldMapping": { "type": "array", "items": { "$ref": "#/components/schemas/FieldMapping" }, "x-go-name": "FieldMappingArray" }, "form": { "$ref": "#/components/schemas/DataCollectionForm" }, "formDisplay": { "$ref": "#/components/schemas/FormDisplay" }, "id": { "type": "string", "x-go-name": "ID" }, "ignoreWorker": { "type": "boolean", "description": "Do not run this task in a worker", "x-go-name": "IgnoreWorker" }, "isAutoSwitchedToQuietMode": { "type": "boolean", "x-go-name": "IsAutoSwitchedToQuietMode" }, "isOverSize": { "type": "boolean", "x-go-name": "IsOverSize" }, "loop": { "$ref": "#/components/schemas/TaskLoop" }, "message": { "$ref": "#/components/schemas/NotifiableItem" }, "nextTasks": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "NextTasks" }, "note": { "type": "boolean", "x-go-name": "Note" }, "quietMode": { "$ref": "#/components/schemas/QuietMode" }, "reputationCalc": { "$ref": "#/components/schemas/ReputationCalcAlg" }, "restrictedCompletion": { "type": "boolean", "x-go-name": "RestrictedCompletion" }, "scriptArguments": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AdvanceArg" }, "x-go-name": "ScriptArguments" }, "separateContext": { "type": "boolean", "x-go-name": "SeparateContext" }, "skipUnavailable": { "type": "boolean", "description": "SkipUnavailable if true then will check if automation exists, integration of that command is installed and\nactive or sub playbook exists in Demisto", "x-go-name": "SkipUnavailable" }, "sla": { "$ref": "#/components/schemas/SLA" }, "slaReminder": { "$ref": "#/components/schemas/SLA" }, "task": { "$ref": "#/components/schemas/Task" }, "taskId": { "type": "string", "x-go-name": "TaskID" }, "timerTriggers": { "type": "array", "description": "SLA fields", "items": { "$ref": "#/components/schemas/TimerTrigger" }, "x-go-name": "TimerTriggers" }, "type": { "$ref": "#/components/schemas/TaskType" }, "view": { "$ref": "#/components/schemas/TaskView" } }, "x-go-package": "github.com/demisto/server/domain" }, "Report": { "type": "object", "description": "Report - represents report", "properties": { "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "createdBy": { "type": "string", "x-go-name": "CreatedBy" }, "cron": { "type": "string", "x-go-name": "Cron" }, "cronView": { "type": "boolean", "x-go-name": "CronView" }, "dashboard": { "$ref": "#/components/schemas/Dashboard" }, "decoder": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ReportFieldsDecoder" }, "x-go-name": "Decoder" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "description": { "type": "string", "x-go-name": "Description" }, "disableHeader": { "type": "boolean", "x-go-name": "DisableHeader" }, "endingDate": { "type": "string", "format": "date-time", "x-go-name": "EndingDate" }, "endingType": { "$ref": "#/components/schemas/EndingType" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "humanCron": { "$ref": "#/components/schemas/HumanCron" }, "id": { "type": "string", "x-go-name": "ID" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "latestReportName": { "type": "string", "x-go-name": "LatestReportName" }, "latestReportTime": { "type": "string", "format": "date-time", "x-go-name": "LatestReportTime" }, "latestReportUsername": { "type": "string", "x-go-name": "LatestReportUsername" }, "latestScheduledReportTime": { "type": "string", "format": "date-time", "x-go-name": "LatestScheduledReportTime" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "nextScheduledTime": { "type": "string", "format": "date-time", "x-go-name": "NextScheduledTime" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "orientation": { "type": "string", "x-go-name": "Orientation" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "paperSize": { "type": "string", "x-go-name": "PaperSize" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "prevType": { "type": "string", "x-go-name": "PrevType" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "recipients": { "type": "array", "items": { "type": "string" }, "x-go-name": "Recipients" }, "recurrent": { "type": "boolean", "x-go-name": "Recurrent" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "reportType": { "type": "string", "x-go-name": "ReportType" }, "runOnce": { "type": "boolean", "x-go-name": "RunOnce" }, "runningRoles": { "type": "array", "items": { "type": "string" }, "x-go-name": "RunningRoles" }, "runningUser": { "type": "string", "x-go-name": "RunningUser" }, "scheduled": { "type": "boolean", "description": "is it scheduled", "x-go-name": "Scheduled" }, "sections": { "type": "array", "items": { "$ref": "#/components/schemas/Section" }, "x-go-name": "Sections" }, "sensitive": { "type": "boolean", "x-go-name": "Sensitive" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "startDate": { "type": "string", "format": "date-time", "x-go-name": "StartDate" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "tags": { "type": "array", "items": { "type": "string" }, "x-go-name": "Tags" }, "times": { "type": "integer", "format": "int64", "x-go-name": "Times" }, "timezone": { "type": "string", "x-go-name": "Timezone" }, "timezoneOffset": { "type": "integer", "format": "int64", "x-go-name": "TimezoneOffset" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "type": { "type": "string", "x-go-name": "Type" }, "userAPIKey": { "type": "string", "x-go-name": "UserAPIKey" }, "userAPIKeyID": { "type": "string", "x-go-name": "UserAPIKeyID" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "ReportFieldsDecoder": { "type": "object", "title": "ReportFieldsDecoder ...", "properties": { "type": { "type": "string", "x-go-name": "Type" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "github.com/demisto/server/domain" }, "Section": { "type": "object", "title": "Section ...", "properties": { "autoPageBreak": { "type": "boolean", "x-go-name": "AutoPageBreak" }, "automation": { "$ref": "#/components/schemas/ReportAutomation" }, "data": { "type": "object", "x-go-name": "Data" }, "description": { "type": "string", "x-go-name": "Description" }, "displayType": { "type": "string", "x-go-name": "DisplayType" }, "emptyNotification": { "type": "string", "x-go-name": "EmptyNotification" }, "fromDate": { "type": "string", "x-go-name": "FromDate" }, "hideItemTitleOnlyOne": { "type": "boolean", "x-go-name": "HideItemTitleOnlyOne" }, "layout": { "type": "object", "x-go-name": "Layout" }, "query": { "$ref": "#/components/schemas/ReportQuery" }, "title": { "type": "string", "x-go-name": "Title" }, "titleStyle": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "TitleStyle" }, "toDate": { "type": "string", "x-go-name": "ToDate" }, "type": { "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/demisto/server/domain" }, "ReportAutomation": { "type": "object", "title": "ReportAutomation ...", "properties": { "args": { "$ref": "#/components/schemas/ModuleArgs" }, "id": { "type": "string", "x-go-name": "ID" }, "name": { "type": "string", "x-go-name": "Name" }, "noEvent": { "type": "boolean", "x-go-name": "NoEvent" } }, "x-go-package": "github.com/demisto/server/domain" }, "ReportQuery": { "type": "object", "title": "ReportQuery ...", "properties": { "customGroupBy": { "$ref": "#/components/schemas/CustomGroups" }, "filter": { "type": "object", "x-go-name": "Filter" }, "groupBy": { "type": "array", "items": { "type": "string" }, "x-go-name": "GroupBy" }, "keys": { "type": "array", "items": { "type": "string" }, "x-go-name": "Keys" }, "type": { "type": "string", "x-go-name": "Type" }, "valuesFormat": { "type": "string", "x-go-name": "ValuesFormat" } }, "x-go-package": "github.com/demisto/server/domain" }, "CustomGroups": { "type": "array", "description": "CustomGroups - a custom group for each group-by element", "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomGroup" } }, "x-go-package": "github.com/demisto/server/domain" }, "CustomGroup": { "type": "object", "description": "CustomGroup - A new custom group that will be created by merging groups based on the Conditions", "properties": { "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Buckets" }, "x-go-name": "Conditions" }, "name": { "type": "string", "x-go-name": "Name" } }, "x-go-package": "github.com/demisto/server/domain" }, "Buckets": { "type": "array", "title": "Buckets - Array of conditional buckets, related by 'OR'", "items": { "$ref": "#/components/schemas/Bucket" }, "x-go-package": "github.com/demisto/server/domain" }, "Bucket": { "type": "object", "title": "Bucket - represents a specific condition term for merging groups into a custom group.", "properties": { "field": { "type": "string", "x-go-name": "Field" }, "operator": { "type": "string", "x-go-name": "Operator" }, "right": { "type": "string", "x-go-name": "RHS" }, "type": { "$ref": "#/components/schemas/OperatorType" } }, "x-go-package": "github.com/demisto/server/domain" }, "OperatorType": { "type": "string", "title": "OperatorType ...", "x-go-package": "github.com/demisto/server/domain" }, "auditResult": { "type": "object", "properties": { "audits": { "type": "array", "items": { "$ref": "#/components/schemas/Audit" }, "x-go-name": "Audits" }, "total": { "type": "integer", "format": "int64", "x-go-name": "Total" } }, "x-go-package": "github.com/demisto/server/web" }, "Audit": { "type": "object", "description": "Audit holds the auditing details. This includes all common fields, the action in a string blob and the user who\nperformed the action in a user struct.", "properties": { "action": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Action" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "id": { "type": "string", "x-go-name": "ID" }, "identifier": { "type": "string", "x-go-name": "Identifier" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "object": { "type": "string", "x-go-name": "Object" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "type": { "type": "string", "x-go-name": "Type" }, "user": { "type": "string", "x-go-name": "User" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" } }, "x-go-package": "github.com/demisto/server/domain" }, "DockerImagesResult": { "type": "object", "description": "DockerImagesResult for the get images request", "properties": { "images": { "type": "array", "items": { "$ref": "#/components/schemas/DockerImage" }, "x-go-name": "Images" } }, "x-go-package": "github.com/demisto/server/web" }, "DockerImage": { "type": "object", "description": "DockerImage details", "properties": { "createdAt": { "type": "string", "x-go-name": "CreatedAt" }, "createdSince": { "type": "string", "x-go-name": "CreatedSince" }, "id": { "type": "string", "x-go-name": "ID" }, "repository": { "type": "string", "x-go-name": "Repository" }, "size": { "type": "string", "x-go-name": "Size" }, "tag": { "type": "string", "x-go-name": "Tag" } }, "x-go-package": "github.com/demisto/server/web" }, "NewDockerImage": { "type": "object", "description": "NewDockerImage creation request", "properties": { "base": { "type": "string", "x-go-name": "BaseImage" }, "dependencies": { "type": "array", "items": { "type": "string" }, "x-go-name": "Dependencies" }, "name": { "type": "string", "x-go-name": "Name" }, "packages": { "type": "array", "items": { "type": "string" }, "x-go-name": "Packages" } }, "x-go-package": "github.com/demisto/server/web" }, "NewDockerImageResult": { "type": "object", "description": "NewDockerImageResult of the command", "properties": { "createdName": { "type": "string", "x-go-name": "CreatedName" }, "output": { "type": "string", "x-go-name": "Output" } }, "x-go-package": "github.com/demisto/server/web" }, "ModuleConfiguration": { "type": "object", "description": "ModuleConfiguration is the configuration parameters for a module", "properties": { "beta": { "type": "boolean", "x-go-name": "Beta" }, "brand": { "type": "string", "x-go-name": "Brand" }, "cacheVersn": { "type": "integer", "format": "int64", "x-go-name": "CacheVersn" }, "canGetSamples": { "type": "boolean", "x-go-name": "CanGetSamples" }, "category": { "type": "string", "x-go-name": "Category" }, "cmdline": { "type": "string", "x-go-name": "Cmdline" }, "commitMessage": { "type": "string", "x-go-name": "CommitMessage" }, "configuration": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigField" }, "x-go-name": "Configuration" }, "created": { "type": "string", "format": "date-time", "x-go-name": "Created" }, "defaultClassifier": { "type": "string", "x-go-name": "DefaultClassifier" }, "defaultMapperIn": { "type": "string", "x-go-name": "DefaultMapperIn" }, "defaultMapperOut": { "type": "string", "x-go-name": "DefaultMapperOut" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "description": { "type": "string", "x-go-name": "Description" }, "detailedDescription": { "type": "string", "x-go-name": "DetailedDescription" }, "display": { "type": "string", "x-go-name": "Display" }, "executable": { "type": "string", "x-go-name": "Executable" }, "fromServerVersion": { "$ref": "#/components/schemas/Version" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "hideEngines": { "type": "boolean", "x-go-name": "HideEngines" }, "highlight": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "Highlight" }, "icon": { "type": "string", "x-go-name": "Icon" }, "id": { "type": "string", "x-go-name": "ID" }, "image": { "type": "string", "x-go-name": "Image" }, "indexName": { "type": "string", "x-go-name": "IndexName" }, "integrationScript": { "$ref": "#/components/schemas/IntegrationScript" }, "isPasswordProtected": { "type": "boolean", "x-go-name": "IsPasswordProtected" }, "itemVersion": { "$ref": "#/components/schemas/Version" }, "locked": { "type": "boolean", "x-go-name": "Locked" }, "modified": { "type": "string", "format": "date-time", "x-go-name": "Modified" }, "name": { "type": "string", "x-go-name": "Name" }, "numericId": { "type": "integer", "format": "int64", "x-go-name": "NumericID" }, "packID": { "type": "string", "x-go-name": "PackID" }, "packName": { "type": "string", "x-go-name": "PackName" }, "packPropagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PackPropagationLabels" }, "path": { "type": "string", "x-go-name": "Path" }, "prevName": { "type": "string", "x-go-name": "PrevName" }, "primaryTerm": { "type": "integer", "format": "int64", "x-go-name": "PrimaryTerm" }, "private": { "type": "boolean", "x-go-name": "Private" }, "propagationLabels": { "type": "array", "items": { "type": "string" }, "x-go-name": "PropagationLabels" }, "readonly": { "type": "boolean", "x-go-name": "ReadOnly" }, "remote": { "type": "boolean", "x-go-name": "Remote" }, "scriptNotVisible": { "type": "boolean", "x-go-name": "ScriptNotVisible" }, "sectionOrder": { "type": "array", "items": { "type": "string" }, "x-go-name": "SectionOrder" }, "sequenceNumber": { "type": "integer", "format": "int64", "x-go-name": "SeqNum" }, "shouldCommit": { "type": "boolean", "x-go-name": "ShouldCommit" }, "sizeInBytes": { "type": "integer", "format": "int64", "x-go-name": "SizeInBytes" }, "sortValues": { "type": "array", "items": { "type": "string" }, "x-go-name": "SortValues" }, "sourceModuleID": { "type": "string", "x-go-name": "SourceModuleID" }, "syncHash": { "type": "string", "x-go-name": "SyncHash" }, "system": { "type": "boolean", "x-go-name": "System" }, "toServerVersion": { "$ref": "#/components/schemas/Version" }, "type": { "type": "string", "x-go-name": "Type" }, "vcShouldIgnore": { "type": "boolean", "x-go-name": "VCShouldIgnore" }, "vcShouldKeepItemLegacyProdMachine": { "type": "boolean", "x-go-name": "VCShouldKeepItemLegacyProdMachine" }, "version": { "type": "integer", "format": "int64", "x-go-name": "Versn" }, "videos": { "type": "array", "items": { "type": "string" }, "x-go-name": "Videos" } }, "x-go-package": "github.com/demisto/server/domain" }, "ConfigField": { "type": "object", "description": "ConfigField holds a configuration field", "properties": { "advanced": { "type": "boolean", "x-go-name": "Advanced" }, "defaultValue": { "type": "string", "x-go-name": "DefaultValue" }, "display": { "type": "string", "x-go-name": "Display" }, "displayPassword": { "type": "string", "x-go-name": "DisplayPassword" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "hiddenPassword": { "type": "boolean", "x-go-name": "HiddenPassword" }, "hiddenUsername": { "type": "boolean", "x-go-name": "HiddenUsername" }, "info": { "type": "string", "x-go-name": "AdditionalInfo" }, "name": { "type": "string", "x-go-name": "Name" }, "options": { "type": "array", "items": { "type": "string" }, "x-go-name": "Options" }, "required": { "type": "boolean", "x-go-name": "Required" }, "section": { "type": "string", "x-go-name": "Section" }, "type": { "$ref": "#/components/schemas/ConfigDataType" } }, "x-go-package": "github.com/demisto/server/domain" }, "ConfigDataType": { "type": "number", "description": "ConfigDataType holds the type of a configuration field or command argument", "format": "double", "x-go-package": "github.com/demisto/server/domain" }, "IntegrationScript": { "type": "object", "title": "IntegrationScript ...", "properties": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/Command" }, "x-go-name": "Commands" }, "dockerImage": { "type": "string", "x-go-name": "DockerImage" }, "feed": { "type": "boolean", "x-go-name": "Feed" }, "isFetch": { "type": "boolean", "x-go-name": "IsFetch" }, "isFetchCredentials": { "type": "boolean", "x-go-name": "IsFetchCredentials" }, "isFetchEvents": { "type": "boolean", "x-go-name": "IsFetchEvents" }, "isFetchSamples": { "type": "boolean", "x-go-name": "IsFetchSamples" }, "isMappable": { "type": "boolean", "x-go-name": "IsMappable" }, "isRemoteSyncIn": { "type": "boolean", "x-go-name": "IsRemoteSyncIn" }, "isRemoteSyncOut": { "type": "boolean", "x-go-name": "IsRemoteSyncOut" }, "longRunning": { "type": "boolean", "x-go-name": "LongRunning" }, "longRunningPortMapping": { "type": "boolean", "x-go-name": "LongRunningPort" }, "resetContext": { "type": "boolean", "x-go-name": "ResetContext" }, "runOnce": { "type": "boolean", "x-go-name": "RunOnce" }, "script": { "type": "string", "x-go-name": "Script" }, "subtype": { "$ref": "#/components/schemas/ScriptSubType" }, "type": { "$ref": "#/components/schemas/ScriptType" } }, "x-go-package": "github.com/demisto/server/domain" }, "Command": { "type": "object", "description": "Command supported by a module", "properties": { "arguments": { "type": "array", "items": { "$ref": "#/components/schemas/Argument" }, "x-go-name": "Arguments" }, "cartesian": { "type": "boolean", "x-go-name": "Cartesian" }, "definitionId": { "type": "string", "x-go-name": "DefinitionID" }, "deprecated": { "type": "boolean", "x-go-name": "Deprecated" }, "description": { "type": "string", "x-go-name": "Description" }, "docsHidden": { "type": "boolean", "x-go-name": "DocsHidden" }, "execution": { "type": "boolean", "x-go-name": "Execution" }, "gomAction": { "type": "boolean", "x-go-name": "GOMAction" }, "hidden": { "type": "boolean", "x-go-name": "Hidden" }, "important": { "type": "array", "items": { "$ref": "#/components/schemas/Important" }, "x-go-name": "Important" }, "indicatorAction": { "type": "boolean", "x-go-name": "IndicatorAction" }, "name": { "type": "string", "x-go-name": "Name" }, "outputs": { "type": "array", "items": { "$ref": "#/components/schemas/Output" }, "x-go-name": "Outputs" }, "permitted": { "type": "boolean", "x-go-name": "Permitted" }, "polling": { "type": "boolean", "x-go-name": "Polling" }, "sensitive": { "type": "boolean", "x-go-name": "Sensitive" }, "timeout": { "type": "integer", "format": "int64", "x-go-name": "Timeout" } }, "x-go-package": "github.com/demisto/server/domain" }, "StatsQueryResponse": { "type": "object", "title": "StatsQueryResponse - Describe the data returned related to a specific widget cell in a dashboard.", "properties": { "accountErrors": { "type": "array", "items": { "type": "string" }, "x-go-name": "AccountErrors" }, "data": { "type": "object", "description": "data array or object describing the statistics data based on type.", "x-go-name": "Data" }, "totalAccounts": { "type": "integer", "format": "int64", "x-go-name": "TotalAccounts" }, "widgetCellId": { "type": "string", "x-go-name": "WidgetCellID" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Unit42IndicatorLookup": { "type": "object", "description": "Unit42IndicatorLookup - indicator lookup result from Unit42 intel", "properties": { "indicator": { "$ref": "#/components/schemas/Unit42Indicator" } }, "x-go-package": "github.com/demisto/server/domain" }, "Unit42Indicator": { "type": "object", "title": "Unit42Indicator ...", "additionalProperties": { "type": "object" }, "x-go-package": "github.com/demisto/server/domain" }, "Unit42SampleSearchFilter": { "type": "object", "title": "Unit42SampleSearchFilter ...", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "accounts": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "fields": { "type": "array", "items": { "type": "string" }, "x-go-name": "Fields" }, "filterobjectquery": { "type": "string", "x-go-name": "FilterObjectQuery" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "period": { "$ref": "#/components/schemas/Period" }, "query": { "type": "string", "x-go-name": "Query" }, "scope": { "type": "string", "x-go-name": "Scope" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "trim_events": { "type": "integer", "format": "int64", "x-go-name": "TrimEvents" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Unit42SearchFilter": { "type": "object", "title": "Unit42SearchFilter ...", "properties": { "Cache": { "type": "object", "description": "Cache of join functions", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "accounts": { "type": "object", "additionalProperties": { "type": "object" }, "x-go-name": "Accounts" }, "fields": { "type": "array", "items": { "type": "string" }, "x-go-name": "Fields" }, "filterobjectquery": { "type": "string", "x-go-name": "FilterObjectQuery" }, "fromDate": { "type": "string", "format": "date-time", "x-go-name": "FromDate" }, "fromDateLicense": { "type": "string", "format": "date-time", "x-go-name": "FromDateLicenseVal" }, "ignoreWorkers": { "type": "boolean", "description": "Do not use workers mechanism while searching bleve", "x-go-name": "IgnoreWorkers" }, "page": { "type": "integer", "description": "0-based page", "format": "int64", "x-go-name": "Page" }, "period": { "$ref": "#/components/schemas/Period" }, "query": { "type": "string", "x-go-name": "Query" }, "searchAfter": { "type": "array", "description": "Efficient next page, pass max sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfter" }, "searchAfterElastic": { "type": "array", "description": "Efficient next page, pass max ES sort value from previous page", "items": { "type": "string" }, "x-go-name": "SearchAfterElastic" }, "searchAfterMap": { "type": "object", "description": "Map accounts search after values - stores next page sort values per account.\nThere is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter]\nMore, there is no way to generate correct searchBefore from current page as some tenants may not appear at all.\nThe map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map.", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "x-go-name": "SearchAfterMap" }, "searchAfterMapOrder": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-go-name": "SearchAfterMapOrder" }, "searchBefore": { "type": "array", "description": "Efficient prev page, pass min sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBefore" }, "searchBeforeElastic": { "type": "array", "description": "Efficient prev page, pass min ES sort value from next page", "items": { "type": "string" }, "x-go-name": "SearchBeforeElastic" }, "size": { "type": "integer", "description": "Size is limited to 1000, if not passed it defaults to 0, and no results will return", "format": "int64", "x-go-name": "Size" }, "sort": { "type": "array", "description": "The sort order", "items": { "$ref": "#/components/schemas/Order" }, "x-go-name": "Sort" }, "timeFrame": { "$ref": "#/components/schemas/Duration" }, "toDate": { "type": "string", "format": "date-time", "x-go-name": "ToDate" }, "trim_events": { "type": "integer", "format": "int64", "x-go-name": "TrimEvents" } }, "x-go-package": "github.com/demisto/server/repo/entities" }, "Info": { "type": "object", "description": "Info - holds all workers status", "properties": { "Available": { "type": "number", "format": "double" }, "BufferSpace": { "type": "integer", "format": "int64" }, "Busy": { "type": "integer", "format": "int64" }, "HighPriorityAvailable": { "type": "number", "format": "double" }, "HighPriorityBufferSpace": { "type": "integer", "format": "int64" }, "Name": { "type": "string" }, "ProcessInfo": { "type": "array", "items": { "$ref": "#/components/schemas/ProcessInfo" } }, "ShouldStop": { "type": "boolean" }, "Total": { "type": "integer", "format": "int64" }, "TotalBuffer": { "type": "integer", "format": "int64" } }, "x-go-package": "github.com/demisto/server/util/workers/workersInfo" }, "ProcessInfo": { "type": "object", "description": "ProcessInfo - holds info per worker", "properties": { "Details": { "type": "string" }, "Duration": { "$ref": "#/components/schemas/Duration" }, "HighPriority": { "type": "boolean" }, "StartedAt": { "type": "string", "format": "date-time" } }, "x-go-package": "github.com/demisto/server/util/workers/workersInfo" } } }, "security": [ { "api_key": [] } ] }