Vectra XDR
Vectra XDR Pack.#
This Integration is part of theSupported versions
Supported Cortex XSOAR versions: 6.8.0 and later.
#
OverviewVectra XDR pack empowers the SOC to create incidents using Vectra AI's Attack Signal Intelligence. This integration was integrated and tested with Vectra API v3.3.
This integration supports only cloud instances of Vectra XDR. To configure an instance provide Server URL, Client ID and Client Secret Key.
#
Use cases- Fetch entities and their detections from Vectra XDR.
- List and Describe Entities and Detections.
- List, Create, Update, and Resolve Entity Assignments.
- List Assignment Outcomes.
- List, Create, Update, and Delete Entity notes.
- List, Update, and Remove Entity tags.
- List, Assign, and Unassign members in Group.
- Mark and Unmark Entity's detections as fixed.
- Download PCAP of detection.
#
Configure Vectra XDR on Cortex XSOARNavigate to Settings > Integrations > Servers & Services.
Search for Vectra XDR.
Click Add instance to create and configure a new integration instance.
Parameter Description Required Server URL URL of the Vectra AI platform. True Client ID Identifies a client or application for authentication and authorization in the Vectra AI platform. True Client Secret Key Secret key used for secure communication with the Vectra AI platform. True Trust any certificate (not secure) When checked, no SSL certificates check will be done when interacting with the Vectra XDR API. It's insecure. (Default - unchecked) False Use system proxy settings Use the system proxy settings to reach with the Vectra XDR API. False Fetch incidents False Max Fetch The maximum number of entities to fetch each time. If the value is greater than 200, it will be considered as 200. The maximum is 200. False First Fetch Time The date or relative timestamp from which to begin fetching entities.
Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ.
For example: 01 May 2023, 01 Mar 2021 04:45:33, 2022-04-17T14:05:44Z.False Mirroring Direction The mirroring direction in which to mirror the entities. You can mirror "Incoming" (from Vectra to XSOAR), "Outgoing" (from XSOAR to Vectra), or in both directions. False Mirror tag for notes The tag value should be used to mirror the entity note by adding the same tag in the notes. False Entity Type Entity Type(Host, Account). False Prioritized Retrieve only prioritize entities based on the configuration on the Vectra platform. If not selected will fetch all entities. False Tags Retrieve entities that contain any of the tags specified. Supports comma-separated values. False Detection Category Retrieve detections belonging to a specified category. False Detection Type Retrieve detections belonging to a specified detection type. False Specify the numeric value of "Urgency Score" for mapping the Low Incident Severity. If the entity's urgency score is equal to or less than the configured threshold, it would be considered as a "Low" Severity Incident. Default is 30. False Specify the numeric value of "Urgency Score" for mapping the Medium Incident Severity. If the entity's urgency score is equal to or less than the configured threshold, it would be considered as a "Medium" Severity Incident.Default is 50. False Specify the numeric value of "Urgency Score" for mapping the High Incident Severity. If the entity's urgency score is equal to or less than the configured threshold,
it would be considered as a "High" Severity Incident and if urgency score greater than threshold, it would be considered as a "Critical" Severity Incident. Default is 80.False Incident type False Click Test to validate the URLs, token, and connection.
#
Configuration for fetching Vectra XDR Entity as an XSOAR IncidentTo fetch Vectra XDR Entity follow the next steps:
- Select Fetches incidents.
- Under Classifier, select "N/A".
- Under Incident type, select "Vectra XDR Entity".
- Under Mapper (incoming), select "Vectra XDR - Incoming Mapper" for default mapping.
- Enter connection parameters. (Server URL, Client ID & Client Secret Key)
- Select SSL certificate validation and Proxy if required.
- Update "Max Fetch" & "First Fetch Time" based on your requirements.
- Select the Incident Mirroring Direction:
- Incoming - Mirrors changes from the Vectra XDR Entity into the Cortex XSOAR incident.
- Outgoing - Mirrors changes from the Cortex XSOAR incident to the Vectra XDR Entity.
- Incoming And Outgoing - Mirrors changes both Incoming and Outgoing directions on incidents.
- Enter the relevant tag name for mirror notes. Note: This value is mapped to the dbotMirrorTags incident field in Cortex XSOAR, which defines how Cortex XSOAR handles notes when you tag them in the War Room. This is required for mirroring notes from Cortex XSOAR to Vectra XDR.
- Provide appropriate values for filtering Entities, such as Entity Type, Prioritization, and Tags. Additionally, specify filters for detections, including Detection Category and Detection Type. Note: Filters for Entities and Detections are combined using 'OR' logic, while filters within the same category(Entity, Detections) are combined using 'AND'.
- Adjust the Urgency Score to categorize Entity severity in Cortex XSOAR. There are three fields for this mapping:
- Input a value for 'Low' severity. Scores up to this limit are labelled as Low.
- The next value is for 'Medium' severity. Scores up to this limit are labelled as Medium.
- The third value is for 'High' severity. Scores up to this limit are labelled as High. Any score above this is marked as 'Critical' severity.
Notes for mirroring:
- This feature is compliant with XSOAR version 6.0 and above.
- When mirroring incidents, you can make changes in Vectra that will be reflected in Cortex XSOAR, or vice versa.
- Any tags removed from the Vectra entity will not be removed in the XSOAR incident, as XSOAR doesn't allow the removal of the tags field via the backend. However, tags removed from the XSOAR incident UI will be removed from the Vectra entity.
- New notes from the XSOAR incident will be created as notes in the Vectra entity. Updates to existing notes in the XSOAR incident will not be reflected in the Vectra entity.
- New notes from the Vectra entity will be created as notes in the XSOAR incident. Updates to existing notes in the Vectra entity will create new notes in the XSOAR incident.
- If a closed XSOAR incident is tied to a specific entity and new detections for that entity arise or existing detections become active again, the incident will be automatically reopened.
- When a XSOAR incident is closed but there are still active detections on the Vectra side, and the entity is subsequently updated, the corresponding XSOAR incident for that entity will be reopened.
- The mirroring settings apply only for incidents that are fetched after applying the settings.
- The mirroring is strictly tied to Incident type "Vectra XDR Entity" & Incoming mapper "Vectra XDR - Incoming Mapper" If you want to change or use your custom incident type/mapper then make sure changes related to these are present.
- If you want to use the mirror mechanism and you're using custom mappers, then the incoming mapper must contain the following fields: dbotMirrorDirection, dbotMirrorId, dbotMirrorInstance, and dbotMirrorTags.
- To use a custom mapper, you must first duplicate the mapper and update the fields in the copy of the mapper. (Refer to the "Create a custom mapper consisting of the default Vectra XDR mapper" section for more information.)
- Following new fields are introduced in the response of the incident to enable the mirroring:
- mirror_direction: This field determines the mirroring direction for the incident. It is a required field for XSOAR to enable mirroring support.
- mirror_tags: This field determines what would be the tag needed to mirror the XSOAR entry out to Vectra XDR. It is a required field for XSOAR to enable mirroring support.
- mirror_instance: This field determines from which instance the XSOAR incident was created. It is a required field for XSOAR to enable mirroring support.
#
Create a custom mapper consisting of the default Vectra XDR mapper- Go to the settings -> Object setup -> Incidents.
- Navigate to the "Classification and Mapping" tab.
- Select the Mapper "Vectra XDR - Incoming Mapper".
- Create a copy of that mapper and click on it. (You can rename the mapper.)
- Under the Incident Type dropdown, verify that the type of Mapper is "Vectra XDR Entity".
- Click on "Choose data path" and map it to the custom field:
- Find the context field you want to map to this incident field on the right side and click on its value.
- Then you will see the path you've selected under your newly added field
- Note: You can also type the path manually.
- Click "Save Version".
- Created mapper will appear in the drop-down for the "Mapper (incoming)" integration instance settings fields.
- Select the newly added mapper at the time of instance configuration.
#
Create a custom layout consisting of the default Vectra XDR layout- Go to the settings -> Object setup -> Incidents.
- Navigate to the "Layouts" tab.
- Select the layout "Vectra XDR Entity".
- Create a copy of that layout and click on it. (You can rename the layout.)
- Select the newly created layout and click on edit.
- To create a new section, drag and drop the "New Section" widget into the layout.
- To add a new field to the layout, navigate to the "Fields and Buttons" section and search for the field. Drag and drop the field widget in the layout.
- Once done, select "Save Version".
- Navigate to the "Incident Type" tab and select "Vectra XDR Entity" type and detach it.
- Attach the newly created layout.
- Reattach the same "Incident Type" again else this incident type will not receive any new updates.
Note: It is recommended to use out-of-the-box mappers, layout & incident types for better visualization and meaningful mappings. If you are changing any out-of-the-box mappers/layout then it might not render all the fields as per the expectation.
#
Troubleshooting#
Receive Notification on an Incident Fetch ErrorThe administrator and Cortex XSOAR users on the recipient's list receive a notification when an integration experiences an incident fetch error. Cortex XSOAR users can select their notification method, such as email, from their user preferences. Refer to this XSOAR documentation for more information.
The following are tips for handling issues with mirroring incidents between Vectra XDR and Cortex XSOAR.
Issue | Recommendation |
---|---|
Mirroring is not working. | Open Context Data and search for dbot. Confirm the dbot fields are configured correctly either through the mapper for that specific incident type or using setIncident. Specifically, make sure the integration instance is configured correctly for the mirroring direction (incoming, outgoing, both) - dbotMirrorId, dbotMirrorDirection, dbotMirrorInstance, dbotMirrorTags. |
Required fields are not getting sent or not visible in UI. | This may be a mapping issue, specifically if you have used a custom mapper make sure you've covered all the out of box mapper fields. |
Notes from XSOAR have not been mirrored in Vectra XDR | Tag is required for mirroring notes from Cortex XSOAR to Vectra XDR. There might be a reason the note is not tagged as the tag needs to be added manually in XSOAR. Click Actions > Tags and add the "note" tag (OR the specific tag name which was set up on Instance Configuration). |
#
CommandsYou can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
#
vectra-user-listReturns a list of users.
#
Base Commandvectra-user-list
#
InputArgument Name | Description | Required |
---|---|---|
username | Filter by username. | Optional |
role | Filter users with the specified role. Possible values are: Admin, Read-Only, Restricted Admin, Security Analyst, Setting Admin, Super Admin. | Optional |
last_login_timestamp | Return only the users which have a last login timestamp equal to or after the given timestamp. Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 01 May 2023, 01 Mar 2021 04:45:33, 2022-04-17T14:05:44Z. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.User.id | Number | The ID of the User. |
Vectra.User.user_id | Number | The ID of the User. |
Vectra.User.username | String | Username of the user. |
Vectra.User.email | String | The email associated with the user. |
Vectra.User.role | String | The role associated with the user. |
Vectra.User.last_login_timestamp | String | Last login timestamp in UTC format of the user. |
Vectra.User.last_login | String | Last login timestamp of the user. |
#
Command example!vectra-user-list
#
Context Example#
Human Readable Output#
Users Table
User ID User Name Role Last Login Timestamp 59 user.name1 Security Analyst 2023-08-22T09:24:44Z 32 user.name2 Super Admin 2023-07-02T18:41:19Z 23 vectra_mdr Vectra MDR
#
vectra-entity-listReturns a list of entities.
#
Base Commandvectra-entity-list
#
InputArgument Name | Description | Required |
---|---|---|
prioritized | Fetch only entities whose priority score is above the configured priority threshold will be included in the response. Possible values are: true, false. | Optional |
entity_type | Specify the type of the entity. Possible values are: account, host. | Optional |
tags | Filter by a tag or a comma-separated list of tags. | Optional |
state | Filter on entity activation state. Possible values are: active, inactive. | Optional |
ordering | Orders records by last timestamp or urgency score. Default sorting is by urgency score in descending order. Use the minus symbol (-) to sort scores in descending order. Multiple ordering fields can be specified with a comma-separated list (e.g., ordering=urgency_score,-name). | Optional |
last_detection_timestamp | Return only the entities which have a last detection timestamp equal to or after the given timestamp. Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 01 May 2023, 01 Mar 2021 04:45:33, 2022-04-17T14:05:44Z. | Optional |
page | Enables the caller to specify a particular page of results. Default is 1. | Optional |
page_size | Specify the desired page size for the request. Maximum is 5000. Default is 50. | Optional |
last_modified_timestamp | Return only the entities which have a last modified timestamp equal to or after the given timestamp. Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 01 May 2023, 01 Mar 2021 04:45:33, 2022-04-17T14:05:44Z. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.id | Number | ID of the entity. |
Vectra.Entity.name | String | Name of the entity. |
Vectra.Entity.breadth_contrib | Number | Breadth contribution of the entity. |
Vectra.Entity.importance | Number | Entity importance. |
Vectra.Entity.type | String | Type of the entity. |
Vectra.Entity.is_prioritized | Boolean | Entity is prioritized or not. |
Vectra.Entity.severity | String | Severity of the entity. |
Vectra.Entity.urgency_score | Number | Urgency score of the entity. |
Vectra.Entity.velocity_contrib | Number | Velocity contribution of the entity. |
Vectra.Entity.detection_set | String | Set of detections related to entity. |
Vectra.Entity.last_detection_timestamp | Date | Time of the last detection activity related to entity. |
Vectra.Entity.notes.id | String | Notes of the entity. |
Vectra.Entity.notes.dateCreated | String | Created date of the Note. |
Vectra.Entity.notes.dateModified | String | Modified date of the Note. |
Vectra.Entity.notes.createdBy | String | Created user of the Note. |
Vectra.Entity.notes.ModifiedBy | String | Modified user of the Note. |
Vectra.Entity.notes.note | String | Note of the entity. |
Vectra.Entity.attack_rating | Number | Attack Ratting of the entity. |
Vectra.Entity.privilege_level | String | Privilege Level of the entity. |
Vectra.Entity.privilege_category | String | Privilege Category of the entity. |
Vectra.Entity.attack_profile | String | Attack Profile of the entity. |
Vectra.Entity.sensors | Unknown | Sensors of the entity. |
Vectra.Entity.state | String | State of the entity. |
Vectra.Entity.tags | Unknown | Tags of the entity. |
Vectra.Entity.url | String | Url link of the entity. |
Vectra.Entity.host_type | Unknown | Host type of the entity. |
Vectra.Entity.account_type | String | Account type of the entity. |
#
Command example!vectra-entity-list entity_type=account page=1 page_size=4 tags=test,test1 prioritized=true state=active
#
Context Example#
Human Readable Output#
Entities Table (Showing Page 1 out of 1)
ID Name Entity Type Urgency Score Entity Importance Last Detection Timestamp Last Modified Timestamp Detections IDs Prioritize State Tags 334 account_name account 100 High 2023-05-15T09:39:24Z 2023-07-18T09:44:24Z 1933, 1934 true active test 335 account_name_1 account 80 High 2023-05-15T09:41:24Z 2023-07-17T09:44:24Z 1935, 1937 true active test, test1 337 account_name_2 account 40 Medium 2023-05-15T09:40:24Z 2023-07-16T09:44:24Z 1835, 1837 true active test1 339 account_name_3 account 21 High 2023-05-15T09:44:24Z 2023-07-15T09:44:24Z 1735, 1737 true active test
#
vectra-entity-describeDescribes an entity by ID.
#
Base Commandvectra-entity-describe
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: host and account. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.id | Number | ID of the entity. |
Vectra.Entity.name | String | Name of the entity. |
Vectra.Entity.breadth_contrib | Number | Breadth contribution of the entity. |
Vectra.Entity.importance | Number | Entity importance. |
Vectra.Entity.type | String | Type of the entity. |
Vectra.Entity.is_prioritized | Boolean | Entity is prioritized or not. |
Vectra.Entity.severity | String | Severity of the entity. |
Vectra.Entity.urgency_score | Number | Urgency score of the entity. |
Vectra.Entity.velocity_contrib | Number | Velocity contribution of the entity. |
Vectra.Entity.detection_set | String | Set of detections related to the entity. |
Vectra.Entity.last_detection_timestamp | Date | Time of the last detection activity related to the entity. |
Vectra.Entity.last_modified_timestamp | Date | Time of the last modification activity related to the entity. |
Vectra.Entity.notes.id | String | Notes of the entity. |
Vectra.Entity.notes.dateCreated | String | Created date of the Note. |
Vectra.Entity.notes.dateModified | String | Modified date of the Note. |
Vectra.Entity.notes.createdBy | String | Created user of the Note. |
Vectra.Entity.notes.ModifiedBy | String | Modified user of the Note. |
Vectra.Entity.notes.note | String | Note of the entity. |
Vectra.Entity.attack_rating | Number | Attack Ratting of the entity. |
Vectra.Entity.privilege_level | String | Privilege Level of the entity. |
Vectra.Entity.privilege_category | String | Privilege Category of the entity. |
Vectra.Entity.attack_profile | String | Attack Profile of the entity. |
Vectra.Entity.sensors | Unknown | Sensors of the entity. |
Vectra.Entity.state | String | State of the entity. |
Vectra.Entity.tags | Unknown | Tags of the entity. |
Vectra.Entity.url | String | Url link of the entity. |
Vectra.Entity.host_type | Unknown | Host type of the entity. |
Vectra.Entity.account_type | Unknown | Account type of the entity. |
#
Command example!vectra-entity-describe entity_type=account entity_id=334
#
Context Example#
Human Readable Output#
Entity detail:334#
Entity ID:
Name Entity Type Urgency Score Entity Importance Last Detection Timestamp Last Modified Timestamp Detections IDs Prioritize State Tags account_name account 100 High 2023-05-15T09:39:24Z 2023-07-28T05:25:47Z 1933, 1934 true active test
#
vectra-entity-detection-listReturns a list of detections for a specified entity.
#
Base Commandvectra-entity-detection-list
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: account, host. | Required |
page | Enables the caller to specify a particular page of results. Default is 1. | Optional |
page_size | Specify the desired page size for the request. Maximum is 5000. Default is 50. | Optional |
detection_category | The category of the detection. Possible values are: Command & Control, Botnet, Reconnaissance, Lateral Movement, Exfiltration, Info. | Optional |
detection_type | Filter by detection type. | Optional |
last_timestamp | Return only the detections which have a last timestamp equal to or after the given timestamp. Formats: YYYY-MM-ddTHH:mm:ssZ, YYYY-MM-dd, N days, N hours. Example: 2023-04-25T00:00:00Z, 2023-04-25, 2 days, 5 hours, 01 Mar 2023, 01 Feb 2023 04:45:33, 15 Jun. | Optional |
detection_name | Filter by detection name. | Optional |
state | Filter by state. Default is active. | Optional |
tags | Filter by a tag or a comma-separated list of tags. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Detections.id | Number | Entity detection ID. |
Vectra.Entity.Detections.assigned_date | Unknown | Date assigned to the detection. |
Vectra.Entity.Detections.assigned_to | Unknown | User or entity assigned to the detection. |
Vectra.Entity.Detections.category | String | Category of the detection. |
Vectra.Entity.Detections.certainty | Number | Certainty level of the detection. |
Vectra.Entity.Detections.c_score | Number | Confidence score of the detection. |
Vectra.Entity.Detections.description | String | Description of the detection. |
Vectra.Entity.Detections.detection | String | Detection information. |
Vectra.Entity.Detections.detection_category | String | Category of the detection. |
Vectra.Entity.Detections.detection_type | String | Type of the detection. |
Vectra.Entity.Detections.grouped_details.external_target.ip | String | IP address of the external target in the detection group. |
Vectra.Entity.Detections.grouped_details.external_target.name | String | Name of the external target in the detection group. |
Vectra.Entity.Detections.grouped_details.num_sessions | Number | Number of sessions in the detection group. |
Vectra.Entity.Detections.grouped_details.bytes_received | Number | Total bytes received in the detection group. |
Vectra.Entity.Detections.grouped_details.bytes_sent | Number | Total bytes sent in the detection group. |
Vectra.Entity.Detections.grouped_details.ja3_hashes | String | JA3 hashes in the detection group. |
Vectra.Entity.Detections.grouped_details.ja3s_hashes | String | JA3S hashes in the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.tunnel_type | String | Tunnel type used in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.protocol | String | Protocol used in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.app_protocol | String | Application protocol used in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_port | Number | Destination port in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_ip | String | Destination IP address in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.bytes_received | Number | Total bytes received in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.bytes_sent | Number | Total bytes sent in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.first_timestamp | Date | First timestamp of the sessions in the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.last_timestamp | Date | Last timestamp of the sessions in the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_geo | Unknown | Geolocation of the destination IP in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_geo_lat | Unknown | Latitude of the destination IP in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_geo_lon | Unknown | Longitude of the destination IP in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.first_timestamp | Date | First timestamp of the detection group. |
Vectra.Entity.Detections.grouped_details.last_timestamp | Date | Last timestamp of the detection group. |
Vectra.Entity.Detections.grouped_details.dst_ips | String | Destination IP addresses in the detection group. |
Vectra.Entity.Detections.grouped_details.dst_ports | Number | Destination ports in the detection group. |
Vectra.Entity.Detections.grouped_details.target_domains | String | Target domains in the detection group. |
Vectra.Entity.Detections.is_targeting_key_asset | Boolean | Indicates if the detection is targeting a key asset. |
Vectra.Entity.Detections.last_timestamp | Date | Last timestamp of the detection. |
Vectra.Entity.Detections.note | Unknown | Note associated with the detection. |
Vectra.Entity.Detections.note_modified_by | Unknown | User or entity who last modified the note. |
Vectra.Entity.Detections.note_modified_timestamp | Unknown | Timestamp when the note was last modified. |
Vectra.Entity.Detections.notes | Unknown | Additional notes related to the detection. |
Vectra.Entity.Detections.sensor_name | String | Name of the sensor associated with the detection. |
Vectra.Entity.Detections.src_account.id | Number | ID of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.name | String | Name of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.url | String | URL of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.threat | Number | Threat level of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.certainty | Number | Certainty level of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.privilege_level | Number | Privilege level of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.privilege_category | String | Privilege category of the source account associated with the detection. |
Vectra.Entity.Detections.src_host.id | Number | ID of the source host in the detection. |
Vectra.Entity.Detections.src_host.ip | String | IP address of the source host in the detection. |
Vectra.Entity.Detections.src_host.name | String | Name of the source host in the detection. |
Vectra.Entity.Detections.src_host.url | String | URL associated with the source host in the detection. |
Vectra.Entity.Detections.src_host.is_key_asset | Boolean | Indicates if the source host is a key asset. |
Vectra.Entity.Detections.src_host.groups | Unknown | Groups associated with the source host in the detection. |
Vectra.Entity.Detections.src_host.threat | Number | Threat level associated with the source host in the detection. |
Vectra.Entity.Detections.src_host.certainty | Number | Certainty level associated with the source host in the detection. |
Vectra.Entity.Detections.src_ip | String | Source IP address in the detection. |
Vectra.Entity.Detections.state | String | State of the detection. |
Vectra.Entity.Detections.summary.num_events | Number | Total number of events related to the detection. |
Vectra.Entity.Detections.summary.bytes_received | Number | Total bytes received in the detection summary. |
Vectra.Entity.Detections.summary.bytes_sent | Number | Total bytes sent in the detection summary. |
Vectra.Entity.Detections.summary.cnc_server | String | CNC server associated with the detection summary. |
Vectra.Entity.Detections.summary.num_events | Number | Total number of events related to the detection. |
Vectra.Entity.Detections.summary.probable_owner | Unknown | Probable owner of the detection summary. |
Vectra.Entity.Detections.summary.sessions | Number | Total sessions in the detection summary. |
Vectra.Entity.Detections.tags | Unknown | Tags associated with the detection. |
Vectra.Entity.Detections.threat | Number | Threat level of the detection. |
Vectra.Entity.Detections.t_score | Number | T-score of the detection. |
Vectra.Entity.Detections.type | String | Type of the detection. |
Vectra.Entity.Detections.url | String | URL associated with the detection. |
#
Command example!vectra-entity-detection-list entity_id=1
#
Context Example#
Human Readable Output#
Detections Table (Showing Page 1 out of 1)
ID Detection Name Detection Type Category Account Name Src IP Threat Score Certainty Score Number Of Events State Last Timestamp 132 Data Smuggler smuggler exfiltration account_name 0.0.0.0 80 70 0 active 2023-06-06T17:01:04Z 135 AWS Suspect Admin Privilege Granting aws_admin_privilege_granted lateral_movement account_name 0.0.0.0 60 50 0 fixed 2023-06-06T17:00:46Z 140 RPC Targeted Recon rpc_recon_1to1 reconnaissance account_name 0.0.0.0 60 40 0 fixed 2023-06-06T15:46:28Z
#
vectra-detection-describeReturns a list of detections for the specified detection ID(s).
#
Base Commandvectra-detection-describe
#
InputArgument Name | Description | Required |
---|---|---|
detection_ids | Specify the ID(s) of the detections. | Required |
page | Enables the caller to specify a particular page of results. Default is 1. | Optional |
page_size | Specify the desired page size for the request. Maximum is 5000. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Detections.id | Number | Entity detection ID. |
Vectra.Entity.Detections.assigned_date | Unknown | Date assigned to the detection. |
Vectra.Entity.Detections.assigned_to | Unknown | User or entity assigned to the detection. |
Vectra.Entity.Detections.category | String | Category of the detection. |
Vectra.Entity.Detections.certainty | Number | Certainty level of the detection. |
Vectra.Entity.Detections.c_score | Number | Confidence score of the detection. |
Vectra.Entity.Detections.description | String | Description of the detection. |
Vectra.Entity.Detections.detection | String | Detection information. |
Vectra.Entity.Detections.detection_category | String | Category of the detection. |
Vectra.Entity.Detections.detection_type | String | Type of the detection. |
Vectra.Entity.Detections.grouped_details.external_target.ip | String | IP address of the external target in the detection group. |
Vectra.Entity.Detections.grouped_details.external_target.name | String | Name of the external target in the detection group. |
Vectra.Entity.Detections.grouped_details.num_sessions | Number | Number of sessions in the detection group. |
Vectra.Entity.Detections.grouped_details.bytes_received | Number | Total bytes received in the detection group. |
Vectra.Entity.Detections.grouped_details.bytes_sent | Number | Total bytes sent in the detection group. |
Vectra.Entity.Detections.grouped_details.ja3_hashes | String | JA3 hashes in the detection group. |
Vectra.Entity.Detections.grouped_details.ja3s_hashes | String | JA3S hashes in the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.tunnel_type | String | Tunnel type used in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.protocol | String | Protocol used in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.app_protocol | String | Application protocol used in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_port | Number | Destination port in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_ip | String | Destination IP address in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.bytes_received | Number | Total bytes received in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.bytes_sent | Number | Total bytes sent in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.first_timestamp | Date | First timestamp of the sessions in the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.last_timestamp | Date | Last timestamp of the sessions in the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_geo | Unknown | Geolocation of the destination IP in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_geo_lat | Unknown | Latitude of the destination IP in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.sessions.dst_geo_lon | Unknown | Longitude of the destination IP in the sessions of the detection group. |
Vectra.Entity.Detections.grouped_details.first_timestamp | Date | First timestamp of the detection group. |
Vectra.Entity.Detections.grouped_details.last_timestamp | Date | Last timestamp of the detection group. |
Vectra.Entity.Detections.grouped_details.dst_ips | String | Destination IP addresses in the detection group. |
Vectra.Entity.Detections.grouped_details.dst_ports | Number | Destination ports in the detection group. |
Vectra.Entity.Detections.grouped_details.target_domains | String | Target domains in the detection group. |
Vectra.Entity.Detections.is_targeting_key_asset | Boolean | Indicates if the detection is targeting a key asset. |
Vectra.Entity.Detections.last_timestamp | Date | Last timestamp of the detection. |
Vectra.Entity.Detections.note | Unknown | Note associated with the detection. |
Vectra.Entity.Detections.note_modified_by | Unknown | User or entity who last modified the note. |
Vectra.Entity.Detections.note_modified_timestamp | Unknown | Timestamp when the note was last modified. |
Vectra.Entity.Detections.notes | Unknown | Additional notes related to the detection. |
Vectra.Entity.Detections.sensor_name | String | Name of the sensor associated with the detection. |
Vectra.Entity.Detections.src_account.id | Number | ID of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.name | String | Name of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.url | String | URL of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.threat | Number | Threat level of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.certainty | Number | Certainty level of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.privilege_level | Number | Privilege level of the source account associated with the detection. |
Vectra.Entity.Detections.src_account.privilege_category | String | Privilege category of the source account associated with the detection. |
Vectra.Entity.Detections.src_host.id | Number | ID of the source host in the detection. |
Vectra.Entity.Detections.src_host.ip | String | IP address of the source host in the detection. |
Vectra.Entity.Detections.src_host.name | String | Name of the source host in the detection. |
Vectra.Entity.Detections.src_host.url | String | URL associated with the source host in the detection. |
Vectra.Entity.Detections.src_host.is_key_asset | Boolean | Indicates if the source host is a key asset. |
Vectra.Entity.Detections.src_host.groups | Unknown | Groups associated with the source host in the detection. |
Vectra.Entity.Detections.src_host.threat | Number | Threat level associated with the source host in the detection. |
Vectra.Entity.Detections.src_host.certainty | Number | Certainty level associated with the source host in the detection. |
Vectra.Entity.Detections.src_ip | String | Source IP address in the detection. |
Vectra.Entity.Detections.state | String | State of the detection. |
Vectra.Entity.Detections.summary.num_events | Number | Total number of events related to the detection. |
Vectra.Entity.Detections.summary.bytes_received | Number | Total bytes received in the detection summary. |
Vectra.Entity.Detections.summary.bytes_sent | Number | Total bytes sent in the detection summary. |
Vectra.Entity.Detections.summary.cnc_server | String | CNC server associated with the detection summary. |
Vectra.Entity.Detections.summary.num_events | Number | Total number of events related to the detection. |
Vectra.Entity.Detections.summary.probable_owner | Unknown | Probable owner of the detection summary. |
Vectra.Entity.Detections.summary.sessions | Number | Total sessions in the detection summary. |
Vectra.Entity.Detections.tags | Unknown | Tags associated with the detection. |
Vectra.Entity.Detections.threat | Number | Threat level of the detection. |
Vectra.Entity.Detections.t_score | Number | T-score of the detection. |
Vectra.Entity.Detections.type | String | Type of the detection. |
Vectra.Entity.Detections.url | String | URL associated with the detection. |
#
Command example!vectra-detection-describe detection_ids=132,135,140
#
Context Example#
Human Readable Output#
Detections Table (Showing Page 1 out of 1)
ID Detection Name Detection Type Category Account Name Src IP Threat Score Certainty Score Number Of Events State Last Timestamp 132 Data Smuggler smuggler exfiltration account_name 0.0.0.0 80 70 0 active 2023-06-06T17:01:04Z 135 AWS Suspect Admin Privilege Granting aws_admin_privilege_granted lateral_movement account_name 0.0.0.0 60 50 0 fixed 2023-06-06T17:00:46Z 140 RPC Targeted Recon rpc_recon_1to1 reconnaissance account_name 0.0.0.0 60 40 0 fixed 2023-06-06T15:46:28Z
#
vectra-entity-note-addAdd a note to the entity.
#
Base Commandvectra-entity-note-add
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: account, host. | Required |
note | Note to be added in the specified entity_id. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Notes.entity_id | String | The ID of the entity associated with the note. |
Vectra.Entity.Notes.note_id | Number | The ID of the note. |
Vectra.Entity.Notes.date_created | Date | The date when the note was created. |
Vectra.Entity.Notes.date_modified | Unknown | The date when the note was last modified. |
Vectra.Entity.Notes.created_by | String | The user who created the note. |
Vectra.Entity.Notes.modified_by | Unknown | The user who last modified the note. |
Vectra.Entity.Notes.note | String | The content of the note. |
#
Command example!vectra-entity-note-add entity_id=1 entity_type=account note="test note"
#
Context Example#
Human Readable Output#
The note has been successfully added to the entity.Returned Note ID: 19
#
vectra-entity-note-updateUpdate a note in the entity.
#
Base Commandvectra-entity-note-update
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: account, host. | Required |
note_id | Specify the ID of the note. | Required |
note | Note to be updated for the specified note_id. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Notes.entity_id | String | ID of the entity associated with the note. |
Vectra.Entity.Notes.note_id | Number | ID of the note. |
Vectra.Entity.Notes.date_created | Date | Date when the note was created. |
Vectra.Entity.Notes.date_modified | Unknown | Date when the note was last modified. |
Vectra.Entity.Notes.created_by | String | User who created the note. |
Vectra.Entity.Notes.modified_by | Unknown | User who last modified the note. |
Vectra.Entity.Notes.note | String | Content of the note. |
#
Command example!vectra-entity-note-update entity_id=1 entity_type=account note_id=1 note="note modified"
#
Context Example#
Human Readable Output#
The note has been successfully updated in the entity.
#
vectra-entity-note-removeRemove a note from the entity.
#
Base Commandvectra-entity-note-remove
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the ID of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: account, host. | Required |
note_id | Specify the ID of the note. | Required |
#
Context OutputThere is no context output for this command.
#
Command Example!vectra-entity-note-remove entity_id=1 entity_type=account note_id=1"
#
Context Example#
Human Readable Output#
The note has been successfully removed from the entity.
#
vectra-entity-tag-addAdd tags in the entity.
#
Base Commandvectra-entity-tag-add
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: host, account. | Required |
tags | Comma-separated values of tags to be included in the entity. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Tags.tag_id | String | ID of the tag. |
Vectra.Entity.Tags.entity_id | String | ID of the entity associated with the tag. |
Vectra.Entity.Tags.entity_type | String | Type of the entity. |
Vectra.Entity.Tags.tags | Unknown | A list of tags linked to an entity. |
#
Command example!vectra-entity-tag-add entity_id=1 entity_type=host tags="tag1, tag2"
#
Context Example#
Human Readable Output#
Tags have been successfully added to the entity.Updated list of tags: tag1, tag2
#
vectra-entity-tag-listReturns a list of tags for a specified entity.
#
Base Commandvectra-entity-tag-list
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: host, account. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Tags.tag_id | String | ID of the tag. |
Vectra.Entity.Tags.entity_id | String | ID of the entity associated with the tag. |
Vectra.Entity.Tags.entity_type | String | Type of the entity. |
Vectra.Entity.Tags.tags | Unknown | A list of tags linked to an entity. |
#
Command example!vectra-entity-tag-list entity_id=1 entity_type=host
#
Context Example#
Human Readable Output#
List of tags: tag1, tag2
#
vectra-entity-tag-removeRemove tags from the entity.
#
Base Commandvectra-entity-tag-remove
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the id of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: host, account. | Required |
tags | Comma-separated values of tags to be removed from the entity. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Tags.tag_id | String | ID of the tag. |
Vectra.Entity.Tags.entity_id | String | ID of the entity associated with the tag. |
Vectra.Entity.Tags.entity_type | String | Type of the entity. |
Vectra.Entity.Tags.tags | Unknown | A list of tags linked to an entity. |
#
Command example!vectra-entity-tag-remove entity_id=1 entity_type=host tags="tag2"
#
Context Example#
Human Readable Output#
Specified tags have been successfully removed for the entity.Updated list of tags: tag1
#
vectra-detections-mark-fixedMark detection as fixed with provided detection IDs in argument.
#
Base Commandvectra-detections-mark-fixed
#
InputArgument Name | Description | Required |
---|---|---|
detection_ids | Provide a list of detection IDs separated by commas or a single detection ID. | Required |
#
Context OutputThere is no context output for this command.
#
Command Example!vectra-detections-mark-fixed detection_ids=1,2,3
#
Context Example#
Human Readable Output#
The provided detection IDs have been successfully marked as fixed.
#
vectra-detections-unmark-fixedUnmark detection as fixed with provided detection IDs in argument.
#
Base Commandvectra-detections-unmark-fixed
#
InputArgument Name | Description | Required |
---|---|---|
detection_ids | Provide a list of detection IDs separated by commas or a single detection ID. | Required |
#
Context OutputThere is no context output for this command.
#
Command Example!vectra-detections-unmark-fixed detection_ids=1,2,3
#
Context Example#
Human Readable Output#
The provided detection IDs have been successfully unmarked as fixed.
#
vectra-entity-assignment-addAdd an assignment for the entity.
#
Base Commandvectra-entity-assignment-add
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the ID of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: account, host. | Required |
user_id | Specify the ID of the user. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Assignments.id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assignment_id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assigned_by.id | Number | ID of the user who assigned the entity. |
Vectra.Entity.Assignments.assigned_by.username | String | Username of the user who assigned the entity. |
Vectra.Entity.Assignments.date_assigned | Date | Date when the entity was assigned. |
Vectra.Entity.Assignments.date_resolved | Date | Date when the entity was resolved. |
Vectra.Entity.Assignments.events.assignment_id | Number | ID of the assignment event. |
Vectra.Entity.Assignments.events.actor | Number | ID of the actor who performed the assignment event. |
Vectra.Entity.Assignments.events.event_type | String | Type of assignment event. |
Vectra.Entity.Assignments.events.datetime | Date | Date of the assignment event. |
Vectra.Entity.Assignments.events.context.to | Number | ID of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_t_score | Number | Threat score of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_c_score | Number | Certainnity score of the entity that was assigned to. |
Vectra.Entity.Assignments.outcome.id | String | ID of the assignment outcome. |
Vectra.Entity.Assignments.outcome.builtin | String | Whether the assignment outcome is builtin or not. |
Vectra.Entity.Assignments.outcome.user_selectable | String | Whether the assignment outcome is user selectable or not.. |
Vectra.Entity.Assignments.outcome.title | String | Title of the assignment outcome. |
Vectra.Entity.Assignments.outcome.category | String | Category of the assignment outcome. |
Vectra.Entity.Assignments.resolved_by.id | Number | ID of the user who resolved the entity. |
Vectra.Entity.Assignments.resolved_by.username | String | Username of the user who resolved the entity. |
Vectra.Entity.Assignments.triaged_detections | Unknown | Number of detections that have been triaged for the entity. |
Vectra.Entity.Assignments.host_id | Number | ID of the host that the entity is associated with. |
Vectra.Entity.Assignments.account_id | Unknown | ID of the account that the entity is associated with. |
Vectra.Entity.Assignments.assigned_to.id | Number | ID of the user who is currently assigned to the entity. |
Vectra.Entity.Assignments.assigned_to.username | String | Username of the user who is currently assigned to the entity. |
#
Command Example!vectra-entity-assignment-add entity_id=1 entity_type=account user_id=1
#
Context Example#
Human Readable Output#
The assignment has been successfully created.#
Assignment detail
Assignment ID Assigned By Assigned Date Assigned To Event Type 1 test_user_2 2023-07-24T08:52:59.367115Z test.user@mail.com created
#
vectra-entity-assignment-updateUpdate an assignment in the entity.
#
Base Commandvectra-entity-assignment-update
#
InputArgument Name | Description | Required |
---|---|---|
assignment_id | Specify the ID of the assignment. | Required |
user_id | Specify the ID of the user. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Assignments.id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assignment_id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assigned_by.id | Number | ID of the user who assigned the entity. |
Vectra.Entity.Assignments.assigned_by.username | String | Username of the user who assigned the entity. |
Vectra.Entity.Assignments.date_assigned | Date | Date when the entity was assigned. |
Vectra.Entity.Assignments.date_resolved | Date | Date when the entity was resolved. |
Vectra.Entity.Assignments.events.assignment_id | Number | ID of the assignment event. |
Vectra.Entity.Assignments.events.actor | Number | ID of the actor who performed the assignment event. |
Vectra.Entity.Assignments.events.event_type | String | Type of assignment event. |
Vectra.Entity.Assignments.events.datetime | Date | Date of the assignment event. |
Vectra.Entity.Assignments.events.context.to | Number | ID of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.from | Number | ID of the entity that was assigned. |
Vectra.Entity.Assignments.events.context.entity_t_score | Number | Threat score of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_c_score | Number | Certainty score of the entity that was assigned to. |
Vectra.Entity.Assignments.outcome.id | String | ID of the assignment outcome. |
Vectra.Entity.Assignments.outcome.builtin | String | Whether the assignment outcome is builtin or not. |
Vectra.Entity.Assignments.outcome.user_selectable | String | Whether the assignment outcome is user selectable or not.. |
Vectra.Entity.Assignments.outcome.title | String | Title of the assignment outcome. |
Vectra.Entity.Assignments.outcome.category | String | Category of the assignment outcome. |
Vectra.Entity.Assignments.resolved_by.id | Number | ID of the user who resolved the entity. |
Vectra.Entity.Assignments.resolved_by.username | String | Username of the user who resolved the entity. |
Vectra.Entity.Assignments.triaged_detections | Unknown | Number of detections that have been triaged for the entity. |
Vectra.Entity.Assignments.host_id | Number | ID of the host that the entity is associated with. |
Vectra.Entity.Assignments.account_id | Unknown | ID of the account that the entity is associated with. |
Vectra.Entity.Assignments.assigned_to.id | Number | ID of the user who is currently assigned to the entity. |
Vectra.Entity.Assignments.assigned_to.username | String | Username of the user who is currently assigned to the entity. |
#
Command Example!vectra-entity-assignment-update assignment_id=1 user_id=2
#
Context Example#
Human Readable Output#
The assignment has been successfully updated.#
Assignment detail
Assignment ID Assigned By Assigned Date Assigned To Event Type 1 api_client 2023-07-21T12:44:10Z test_user_2 reassigned
#
vectra-entity-assignment-resolveResolve an assignment in the entity.
#
Base Commandvectra-entity-assignment-resolve
#
InputArgument Name | Description | Required |
---|---|---|
assignment_id | Specify the ID of the assignment. | Required |
outcome | Specify the Outcome for resolving an assignment in the entity. The custom outcome is allowed. Possible values are: Benign True Positive, Malicious True Positive, False Positive. | Required |
note | A note to be added for resolving an assignment in the entity. Default is Updated by XSOAR. | Optional |
triage_as | Triage rule for resolving an assignment in the entity. | Optional |
detection_ids | Provide a list of detection IDs separated by commas or a single detection ID. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Assignments.id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assignment_id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assigned_by.id | Number | ID of the user who assigned the entity. |
Vectra.Entity.Assignments.assigned_by.username | String | Username of the user who assigned the entity. |
Vectra.Entity.Assignments.date_assigned | Date | Date when the entity was assigned. |
Vectra.Entity.Assignments.date_resolved | Date | Date when the entity was resolved. |
Vectra.Entity.Assignments.events.assignment_id | Number | ID of the assignment event. |
Vectra.Entity.Assignments.events.actor | Number | ID of the actor who performed the assignment event. |
Vectra.Entity.Assignments.events.event_type | String | Type of the assignment event. |
Vectra.Entity.Assignments.events.datetime | Date | Date of the assignment event. |
Vectra.Entity.Assignments.events.context.to | Number | ID of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_t_score | Number | Threat score of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_c_score | Number | Certainty score of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.triage_as | String | Triage status of the entity. |
Vectra.Entity.Assignments.events.context.triaged_detection_ids | Array | IDs of the detections that have been triaged for the entity. |
Vectra.Entity.Assignments.events.context.fixed_detection_ids | Array | IDs of the detections that have been fixed. |
Vectra.Entity.Assignments.events.context.created_rule_ids | Array | IDs of the rules that have been created for the entity. |
Vectra.Entity.Assignments.outcome.id | Number | ID of the assignment outcome. |
Vectra.Entity.Assignments.outcome.builtin | Boolean | Whether the assignment outcome is builtin or not. |
Vectra.Entity.Assignments.outcome.user_selectable | Boolean | Whether the assignment outcome is user selectable or not. |
Vectra.Entity.Assignments.outcome.title | String | Title of the assignment outcome. |
Vectra.Entity.Assignments.outcome.category | String | Category of the assignment outcome. |
Vectra.Entity.Assignments.resolved_by.id | Number | ID of the user who resolved the entity. |
Vectra.Entity.Assignments.resolved_by.username | String | Username of the user who resolved the entity. |
Vectra.Entity.Assignments.triaged_detections | Array | Number of detections that have been triaged for the entity. |
Vectra.Entity.Assignments.host_id | Number | ID of the account that the entity is associated with. |
Vectra.Entity.Assignments.account_id | Number | ID of the host that the entity is associated with. |
Vectra.Entity.Assignments.assigned_to.id | Number | ID of the user who is currently assigned to the entity. |
Vectra.Entity.Assignments.assigned_to.username | String | Username of the user who is currently assigned to the entity. |
#
Command Example!vectra-entity-assignment-resolve assignment_id=116 outcome="Custom outcome" detection_ids=1431,1432,1433 triage_as="triage rule"
#
Context Example#
Human Readable Output#
The assignment has been successfully resolved.
#
vectra-entity-detections-mark-fixedMark the detections of the entity as fixed with the provided entity ID in the argument.
#
Base Commandvectra-entity-detections-mark-fixed
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the ID of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: account, host. | Required |
#
Context OutputThere is no context output for this command.
#
Command Example!vectra-entity-detections-mark-fixed entity_id=1 entity_type="account"
#
Context Example#
Human Readable Output#
The detections (1431, 1432) of the provided entity ID have been successfully marked as fixed.
#
vectra-detection-pcap-downloadDownload pcap of the detection.
#
Base Commandvectra-detection-pcap-download
#
InputArgument Name | Description | Required |
---|---|---|
detection_id | Specify the ID of the detection. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
File.Size | Number | The size of the file. |
File.SHA1 | String | The SHA1 hash of the file. |
File.SHA256 | String | The SHA256 hash of the file. |
File.SHA512 | String | The SHA512 hash of the file. |
File.Name | String | The name of the file. |
File.SSDeep | String | The SSDeep hash of the file. |
File.EntryID | String | The entry ID of the file. |
File.Info | String | File information. |
File.Type | String | The file type. |
File.MD5 | String | The MD5 hash of the file. |
File.Extension | String | The file extension. |
#
Command Example!vectra-detection-pcap-download detection_id="116"
#
Context Example#
Human Readable OutputUploaded file: IP-192.168.55.10_hidden_dns_tunnel_1382.pcap
Property Type Size Info MD5 SHA1 SHA256 SHA512 SSDeep Value application/vnd.tcpdump.pcap 23,988 bytes pcap-ng capture file - version 1.0 709db6e1f8f5054ca57caf43ba248ed6 49fe55c6aef85549261b46dd2e54f8d485306ee5 8615bde9332584b4fd4fe4dc2cc6fc4c75504f6d44667814456c089fd413aa4d 3fa29be0e20884c850b62d2a99aa09b24488289ba0bc9aff37ebe982c21d3a78fb26d9c9ac7fbf2a0839ba649dc0a845f30e7f13de3a0c6284c3c2ac54102143 384:dN+Pm11R0XPmts64kZog9ZaikYngk+SnRxFyeyCEyuAOasucOcakca0/rHfcjOUI:dI+t25caEPjRSnmuNasxRana4DgOUDcX
#
vectra-assignment-listReturns a list of all assignments.
#
Base Commandvectra-assignment-list
#
InputArgument Name | Description | Required |
---|---|---|
entity_ids | Specify the IDs of the entities. Comma-separated values supported. | Optional |
entity_type | Specify the type of the entity. Possible values are: account, host. | Optional |
resolved | Filter by resolved status. Possible values are: True, False. | Optional |
assignees | Filter by user ids of the assignment. Comma-separated values supported. | Optional |
resolution | Filter by outcome ids of the resolution. Comma-separated values supported. | Optional |
created_after | Filter by created after the timestamp. Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 01 May 2023, 01 Mar 2021 04:45:33, 2022-04-17T14:05:44Z. | Optional |
page | Enables the caller to specify a particular page of results. Default is 1. | Optional |
page_size | Specify the desired page size for the request. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Assignments.id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assignment_id | Number | ID of the assignment. |
Vectra.Entity.Assignments.assigned_by.id | Number | ID of the user who assigned the entity. |
Vectra.Entity.Assignments.assigned_by.username | String | Username of the user who assigned the entity. |
Vectra.Entity.Assignments.date_assigned | Date | Date when the entity was assigned. |
Vectra.Entity.Assignments.date_resolved | Date | Date when the entity was resolved. |
Vectra.Entity.Assignments.events.assignment_id | Number | ID of the assignment event. |
Vectra.Entity.Assignments.events.actor | Number | ID of the actor who performed the assignment event. |
Vectra.Entity.Assignments.events.event_type | String | Type of the assignment event. |
Vectra.Entity.Assignments.events.datetime | Date | Date of the assignment event. |
Vectra.Entity.Assignments.events.context.to | Number | ID of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_t_score | Number | Threat score of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.entity_c_score | Number | Certainty score of the entity that was assigned to. |
Vectra.Entity.Assignments.events.context.triage_as | String | Triage status of the entity. |
Vectra.Entity.Assignments.events.context.triaged_detection_ids | Array | IDs of the detections that have been triaged for the entity. |
Vectra.Entity.Assignments.events.context.fixed_detection_ids | Array | IDs of the detections that have been fixed. |
Vectra.Entity.Assignments.events.context.created_rule_ids | Array | IDs of the rules that have been created for the entity. |
Vectra.Entity.Assignments.outcome.id | Number | ID of the assignment outcome. |
Vectra.Entity.Assignments.outcome.builtin | Boolean | Whether the assignment outcome is builtin or not. |
Vectra.Entity.Assignments.outcome.user_selectable | Boolean | Whether the assignment outcome is user selectable or not. |
Vectra.Entity.Assignments.outcome.title | String | Title of the assignment outcome. |
Vectra.Entity.Assignments.outcome.category | String | Category of the assignment outcome. |
Vectra.Entity.Assignments.resolved_by.id | Number | ID of the user who resolved the entity. |
Vectra.Entity.Assignments.resolved_by.username | String | Username of the user who resolved the entity. |
Vectra.Entity.Assignments.triaged_detections | Array | Number of detections that have been triaged for the entity. |
Vectra.Entity.Assignments.host_id | Number | ID of the host that the entity is associated with. |
Vectra.Entity.Assignments.account_id | Number | ID of the account that the entity is associated with. |
Vectra.Entity.Assignments.assigned_to.id | Number | ID of the user who is currently assigned to the entity. |
Vectra.Entity.Assignments.assigned_to.username | String | Username of the user who is currently assigned to the entity. |
#
Command Example!vectra-assignment-list
#
Context Example#
Human Readable Output#
Assignments Table (Showing Page 1 out of 1)
Account ID Host ID Assignment ID Assigned By Assigned To Date Assigned Resolved By Date Resolved Outcome ID Outcome 220 214 test.user4@mail.com test.user2@mail.com 2023-08-18T10:55:29Z 108 212 test.user4@mail.com test.user1@mail.com 2023-08-18T06:29:56Z test.user4@mail.com 2023-08-18T06:32:09Z 1 Benign True Positive
#
vectra-assignment-outcome-listReturns a list of all entity assignment outcomes.
#
Base Commandvectra-assignment-outcome-list
#
InputArgument Name | Description | Required |
---|---|---|
page | Enables the caller to specify a particular page of results. Default is 1. | Optional |
page_size | Specify the desired page size for the request. Default is 50. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Assignments.Outcomes.id | Number | ID of the assignment outcome. |
Vectra.Entity.Assignments.Outcomes.builtin | Boolean | Whether the assignment outcome is builtin or not. |
Vectra.Entity.Assignments.Outcomes.user_selectable | Boolean | Whether the assignment outcome is user selectable or not. |
Vectra.Entity.Assignments.Outcomes.title | String | Title of the assignment outcome. |
Vectra.Entity.Assignments.Outcomes.category | String | Category of the assignment outcome. |
#
Command Example!vectra-assignment-outcome-list page=1 page_size=5
#
Context Example#
Human Readable Output#
Assignment Outcomes Table (Showing Page 1 out of 1)
ID Title Category Built IN User Selectable 1 Benign True Positive benign_true_positive true true 2 Malicious True Positive malicious_true_positive true true 3 False Positive false_positive true true 6 Custom outcome benign_true_positive false true 7 Custom outcome1 benign_true_positive false true
#
vectra-entity-note-listReturns a list of notes for a specified entity.
#
Base Commandvectra-entity-note-list
#
InputArgument Name | Description | Required |
---|---|---|
entity_id | Specify the ID of the entity. | Required |
entity_type | Specify the type of the entity. Possible values are: host, account. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Entity.Notes.note_id | Number | ID of the note. |
Vectra.Entity.Notes.id | Number | ID of the note. |
Vectra.Entity.Notes.date_created | Date | Date when the note was created. |
Vectra.Entity.Notes.date_modified | Unknown | Date when the note was last modified. |
Vectra.Entity.Notes.created_by | String | User who created the note. |
Vectra.Entity.Notes.modified_by | Unknown | User who last modified the note. |
Vectra.Entity.Notes.note | String | Content of the note. |
Vectra.Entity.Notes.entity_id | String | ID of the entity associated with the note. |
Vectra.Entity.Notes.entity_type | String | Type of the entity associated with the note. |
#
Command Example!vectra-entity-note-list entity_id="107" entity_type="account"
#
Context Example#
Human Readable Output#
Entity Notes Table
Note ID Note Created By Created Date Modified By Modified Date 1070 From XSOAR test_user@mail.com 2023-08-25T07:09:08Z test_user@mail.com 2023-08-25T08:10:08Z 1069 Test note test_user@mail.com 2023-08-25T07:08:58Z test_user@mail.com 2023-08-25T08:10:08Z 922 [Mirrored From XSOAR] XSOAR Incident ID: 14228
Note:XSOAR note
Added By: adminapi_client 2023-08-16T05:23:33Z
#
vectra-group-listReturns a list of all groups.
#
Base Commandvectra-group-list
#
InputArgument Name | Description | Required |
---|---|---|
group_type | Filter by group type. Possible values are: account, host, ip, domain. | Optional |
account_names | Filter by Account Names. Supports comma-separated values. Note: Only valid when the group_type parameter is set to "account". | Optional |
domains | Filter by Domains. Supports comma-separated values. Note: Only valid when the group_type parameter is set to "domain". | Optional |
host_ids | Filter by Host IDs. Supports comma-separated values. Note: Only valid when the group_type parameter is set to "host". | Optional |
host_names | Filter by Host Names. Supports comma-separated values. Note: Only valid when the group_type parameter is set to "host". | Optional |
importance | Filter by group importance. Possible values are: high, medium, low, never_prioritize. | Optional |
ips | Filter by IPs. Supports comma-separated values. Note: Only valid when the group_type parameter is set to "ip". | Optional |
description | Filter by group description. | Optional |
last_modified_timestamp | Return only the groups which have a last modification timestamp equal to or after the given timestamp. Supported formats: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ. For example: 01 May 2023, 01 Mar 2023 04:45:33, 2023-04-17T14:05:44Z. | Optional |
last_modified_by | Filters by the user id who made the most recent modification to the group. | Optional |
group_name | Filters by group name. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Group.group_id | Number | ID of the group. |
Vectra.Group.id | Number | ID of the group. |
Vectra.Group.name | String | Name of the group. |
Vectra.Group.description | String | Description of the group. |
Vectra.Group.last_modified | Date | Date when the group was last modified. |
Vectra.Group.last_modified_by | String | Name of the user who last modified the group. |
Vectra.Group.type | String | Type of the group. |
Vectra.Group.members | Unknown | Members of the group. |
Vectra.Group.members.id | Number | Entity ID of member. |
Vectra.Group.members.name | String | Entity name of member. |
Vectra.Group.members.is_key_asset | Boolean | Indicates key asset. |
Vectra.Group.members.url | String | Entity URL of member. |
Vectra.Group.members.uid | String | Entity UID of member. |
Vectra.Group.rules.triage_category | String | Triage category of rule. |
Vectra.Group.rules.id | Number | Id of the rule. |
Vectra.Group.rules.description | String | Description of the rule. |
Vectra.Group.importance | String | Importance level of the group. |
Vectra.Group.cognito_managed | Boolean | Whether the group is managed by Cognito or not. |
#
Command Example!vectra-group-list
#
Context Example#
Human Readable Output#
Groups Table
Group ID Name Group Type Description Importance Members Last Modified Timestamp 1 Cognito - Box domain Domains used by the Box service medium *.abc.com, *.xyz.net 2023-05-31T13:57:53Z 8 Cognito - IPAM host IPAM, created by Cognito medium 97, 212 2023-08-18T09:16:54Z 16 Cognito - Guest Wifi ip IP space used by Guest Wifi medium 0.0.0.0, 0.0.0.1 2023-08-18T08:55:54Z 22 Dev-Group-Account-High account high O300:service-principal_00000000-0000-0000-0000-000000000001, administrator@fictotech.com 2023-08-25T10:17:37Z
#
vectra-group-assignAssign members to the specified group.
#
Base Commandvectra-group-assign
#
InputArgument Name | Description | Required |
---|---|---|
group_id | Specify Group ID to assign members. | Required |
members | Member values based on the group type. Supports comma-separated values. Note: If the group type is host, then the "Host IDs". If the group type is account, then "Account Names". If the group type is ip, then the list of "IPs". If the group type is domain, then the list of "Domains" . | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Group.group_id | Number | ID of the group. |
Vectra.Group.id | Number | ID of the group. |
Vectra.Group.name | String | Name of the group. |
Vectra.Group.description | String | Description of the group. |
Vectra.Group.last_modified | Date | Date when the group was last modified. |
Vectra.Group.last_modified_by | String | Name of the user who last modified the group. |
Vectra.Group.type | String | Type of the group. |
Vectra.Group.members | Unknown | Members of the group. |
Vectra.Group.members.id | Number | Entity ID of member. |
Vectra.Group.members.name | String | Entity name of member. |
Vectra.Group.members.is_key_asset | Boolean | Indicates key asset. |
Vectra.Group.members.url | String | Entity URL of member. |
Vectra.Group.members.uid | String | Entity UID of member. |
Vectra.Group.rules.triage_category | String | Triage category of rule. |
Vectra.Group.rules.id | Number | Id of the rule. |
Vectra.Group.rules.description | String | Description of the rule. |
#
Command Example!vectra-group-assign group_id=23 members="*.domain4.com,*.domain5.com"
#
Context Example#
Human Readable Output#
Member(s) *.domain4.com, *.domain5.com have been assigned to the group.#
Updated group details:
Group ID Name Group Type Description Members Last Modified Timestamp 1 xsoar-group-accout-test domain xsoar-group-accout-test *.domain1.net, *.domain2.com, *.domain3.com, *.domain4.com, *.domain5.com 2023-09-04T06:30:01Z
#
vectra-group-unassignUnassign members from the specified group.
#
Base Commandvectra-group-unassign
#
InputArgument Name | Description | Required |
---|---|---|
group_id | Specify Group ID to unassign members. | Required |
members | Member values based on the group type. Supports comma-separated values. Note: If the group type is host, then the "Host IDs". If the group type is account, then "Account Names". If the group type is ip, then the list of "IPs". If the group type is domain, then the list of "Domains" . | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Vectra.Group.group_id | Number | ID of the group. |
Vectra.Group.id | Number | ID of the group. |
Vectra.Group.name | String | Name of the group. |
Vectra.Group.description | String | Description of the group. |
Vectra.Group.last_modified | Date | Date when the group was last modified. |
Vectra.Group.last_modified_by | String | Name of the user who last modified the group. |
Vectra.Group.type | String | Type of the group. |
Vectra.Group.members | Unknown | Members of the group. |
Vectra.Group.members.id | Number | Entity ID of member. |
Vectra.Group.members.name | String | Entity name of member. |
Vectra.Group.members.is_key_asset | Boolean | Indicates key asset. |
Vectra.Group.members.url | String | Entity URL of member. |
Vectra.Group.members.uid | String | Entity UID of member. |
Vectra.Group.rules.triage_category | String | Triage category of rule. |
Vectra.Group.rules.id | Number | Id of the rule. |
Vectra.Group.rules.description | String | Description of the rule. |
#
Command Example!vectra-group-unassign group_id=23 members="*.domain4.com,*.domain5.com"
#
Context Example#
Human Readable Output#
Member(s) *.domain4.com, *.domain5.com have been unassigned from the group.#
Updated group details:
Group ID Name Group Type Description Members Last Modified Timestamp 1 xsoar-group-accout-test domain xsoar-group-accout-test *.domain1.net, *.domain2.com, *.domain3.com 2023-09-04T07:30:01Z