Vectra AI NDR
App Vendor: Vectra AI NDR
App Category: Network Security
Connector Version: 1.1.0
API Version: v3.3
About App
The Vectra AI NDR app is configured with Cyware Orchestrate to perform the following actions:
Action Name | Description |
---|---|
Create Detection Notes | This action creates detection notes in Vectra AI. |
Download PCAP Report | This action downloads the PCAP report of a specific detection using the detection ID. |
Generic Action | This is a generic action used to transcend the actions implemented by making a request to any endpoint. |
Get Account Details | This action is used to get details of a specific account using the account ID. |
Get Detection Details | This action retrieves the details of a detection. |
Get Detection Events | This action retrieves the detection events in Vectra AI. |
Get Detection Notes | This action retrieves the detection notes associated with the detection ID. |
Get Entity Details | This action retrieves the entity details using the entity ID. |
Get Host Details | This action retrieves the host details using the host ID. |
List Accounts | This action lists all accounts in the Vectra AI server. |
List All Detections | This action lists all detections in Vectra AI. |
List Entities | This action lists all entities in Vectra AI. |
List Groups | This action lists all groups in Vectra AI. |
List Hosts | This action lists all hosts in Vectra AI. |
Configuration Parameters
The following configuration parameters are required for the Vectra AI NDR app to communicate with the Vectra AI NDR enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Base URL | Enter the base URL to connect to the Vectra API server. | Text | Required |
|
Client ID | Enter the client ID to connect to the Vectra API server. | Text | Required |
|
Client Secret | Enter the client secret to connect to the Vectra API server. | Password | Required |
|
Verify | Select the SSL/TLS certification status. | Boolean | Optional |
|
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Vectra AI. | Integer | Optional | Available range: 15-120 seconds default value: 15 seconds |
Action: Create Detection Notes
This creates detection notes in Vectra AI
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Note | Enter the note to be created. Example: 'this is a test note' | Text | Required | |
Detection ID | Enter the detection ID to create the detection notes. | Text | Required |
Action: Download PCAP Report
This action is used to download the PCAP report of a specific detection using the detection ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Detection ID | Enter the detection ID to download the PCAP report. | Text | Required |
Action: Generic Action
This is a generic action used to transcend the actions implemented by making a request to any endpoint
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Method | Enter the HTTP method to make. | Text | Required | |
Endpoint | Enter the endpoint to make the request. Example: /api/v2/detections | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional |
Action: Get Account Details
This action retrieves details of a specific account using the account ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Account ID | Enter the account ID to get the specific account details. | Text | Required |
Action: Get Detection Details
This action retrieves the details of a detection.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Detection ID | Enter the detection ID to get the detection details. | Text | Required |
Action: Get Detection Events
This action retrieves the detection events in Vectra AI.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Filters | Enter the extra parameters to pass to the api. Example: {'page': 1, 'page_size': 10, 'status': 'active'} | Key Value | Optional |
Action: Get Detection Notes
This action retrieves the detection notes associated with the detection ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Detection ID | Enter the detection ID to get the detection notes. | Text | Required |
Action: Get Entity Details
This action is used to get the entity details using the entity id
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Entity ID | Enter the entity ID to get the entity details | Text | Required |
|
Action: Get Host Details
This action retrieves the host details using the host ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Host ID | Enter the host ID to get the specific host details. | Text | Required |
Action: List Accounts
This action lists all accounts in the Vectra API server.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Filters | Enter the extra parameters to pass to the API. Example: {'page': 1, 'page_size': 10} | Key Value | Optional |
|
Action: List All Detections
This action lists all detections in Vectra AI.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Filters | Enter the extra parameters to pass to the API. Example: {'page': 1, 'page_size': 10, 'status': 'active'} | Key Value | Optional |
Action: List Entities
This action lists all entities in Vectra AI.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Filters | Enter the extra parameters to pass to the API. Example: {'page': 1, 'page_size': 10, 'status': 'active'} | Key Value | Optional |
Action: List Groups
This action lists all groups in Vectra AI.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Filters | Enter the extra parameters to pass to the API. Example: {'page': 1, 'page_size': 10, 'status': 'active'} | Key Value | Optional |
Action: List Hosts
This action lists all hosts in Vectra AI.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
---|---|---|---|---|
Filters | Enter the extra parameters to pass to the API. Example: {'page': 1, 'page_size': 10, 'status': 'active'} | Key Value | Optional |