> For the complete documentation index, see [llms.txt](https://docs.expel.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.expel.io/connect-your-technology/q-z-integrations/vectra-ai-ndr-setup-for-workbench.md).

# Vectra AI (NDR) Setup for Workbench

## Scope and Limitations <a href="#h_01k36pbzk6g0zwyqz3vqvvrjz0" id="h_01k36pbzk6g0zwyqz3vqvvrjz0"></a>

When choosing to set up this integration, remember the following:

* We only developed on the 3.0+ REST API (RUX).

## Prerequisites <a href="#h_01k36pbzk7sg5tfrydp2yfnhak" id="h_01k36pbzk7sg5tfrydp2yfnhak"></a>

* You must have a Vectra account with Admin privileges in order to create the API client and the Expel user.

## Step 1: Create an API Client for Expel in Vectra <a href="#h_01k36pbzk9nhhzt9202j83n5zb" id="h_01k36pbzk9nhhzt9202j83n5zb"></a>

The API client allows Workbench to access Vectra's data.

1. Log in to the Vectra console. *Make sure you know your unique **Vectra console URL**, as you will need it in a later step.*
2. In the side menu navigate to **Manage > API Clients**.<br>

   <div align="left"><figure><img src="/files/UQMsbVe2yCWBpYSO42Rp" alt="Vectra AI menus with Manage and API Clients selected." width="375"><figcaption></figcaption></figure></div>
3. Select **Add API Client**.
4. Configure the API client as follows:
   * **Client Name** - enter a client name (example: "Expel").
   * **Role** - select **Security Analyst**.
   * **Description** - enter a description if desired, or leave blank.
5. Select **Generate Credentials**.
6. Copy and save your **Client ID** and **Secret Key** to a safe place, as you will need them in a later step.

   <div align="left"><figure><img src="/files/oGJWwNQlXHV5MBD36bbB" alt="API Client Created screen displays the Client ID and Secret Key, noting this is the only time you&#x27;ll see the secret key." height="201" width="384"><figcaption></figcaption></figure></div>
7. Select **Done** to close the window.

## Step 2: Create a New Expel User in Vectra <a href="#h_01k36pbzkfye58zqpn4n2wcq9k" id="h_01k36pbzkfye58zqpn4n2wcq9k"></a>

Creating a user for Expel allows us to access your console. [Why do we need console access?](/connect-your-technology/about-integrations/why-expel-asks-for-console-access.md)

1. Still in the Vectra console, use the side menu to navigate to **Manage > Users**.
2. Select **Create New User**.
3. In the window, set up the Expel user:
   * **Name** - enter "Expel Analyst".
   * **Email** - enter "soc+**\<Your\_Organization\_Name>**@expel.io".
     * For example, if your organization were Acme Corp, the format would be "<soc+acme_corp@expel.io>".
   * **Role** - select **Security Analyst**.
4. Select **Create**.
5. Expel will receive the email invitation and complete console access configuration in Workbench on your behalf. We will notify you when the process is complete.
6. While you wait, continue to the next step.&#x20;

## Step 3: Add Vectra AI (NDR) as a Security Device in Workbench <a href="#h_01k36pbzkkxb01hrn8tahsq400" id="h_01k36pbzkkxb01hrn8tahsq400"></a>

**Before you begin, make sure you have your unique Vectra console URL, as well as the Client ID and Secret Key from** [**Step 1**](#h_01k36pbzk9nhhzt9202j83n5zb)**.**

1. [Log in to Workbench](https://workbench.expel.io/auth/login?orig=%2F).
2. In the side menu, navigate to **Organization Settings** > **Security Devices**. If you have multiple organizations, you must select the appropriate organization name from the list.
3. Select **Add Security Device**.
4. In the search box, type “Vectra” and then select the Vectra AI (NDR) integration.
5. Complete the fields as follows:
   * **Name** - enter a name that might help you more easily identify this integration, such as “CompanyName Vectra”; this name will display in Workbench under the Name column, and is a text string that you can filter on.
   * **Location** - enter the location of your integration, for example “cloud;” this is also a text string that you can filter on, so we recommend being consistent with location naming across your Expel integrations.
   * **Vectra Console URL** - enter your unique Vectra console URL, making sure to remove the trailing slash (/). Example: `https://209437179984.uw2.portal.vectra.ai`
   * **Client ID** - enter the Client ID generated in [Step 1.](#h_01k36pbzk9nhhzt9202j83n5zb)
   * **Secret Key** - enter the Secret Key generated in [Step 1](#h_01k36pbzk9nhhzt9202j83n5zb).
   * Select **Save**.
6. Select **Set up later** from the console access dropdown, as we will finish this step for you.
7. Select **Save**.

Your device should be created successfully within a few seconds. A few reminders:

* After your connection is healthy, it will take some time for your device to begin polling and receiving data.
* To check on the status, select the downward arrow for your device in the first column and choose **View details**.
* Polling will happen first; data will be received after that. **You must refresh the page to see updates.**
* If your device does not begin polling within 15 minutes, and does not begin receiving data within 30 minutes, [contact our support team for help](/support/how-to-reach-us.md).
* To check if alerts are coming through, navigate to **Dashboards > Alert Analysis**. Scroll to the device you want to check, and select the **Expel Alerts** tab to reveal more alert information. It can take 36 to 72 hours for alerts to appear after setup, as we [tune your device](/workbench-reference/alerts/how-expel-alerts-work.md#device-tuning).

## Troubleshooting <a href="#h_01k36pbzkthy6p7gcr413ek7hh" id="h_01k36pbzkthy6p7gcr413ek7hh"></a>

If your device is not healthy after saving:

* Make sure you have the correct Vector console URL, and that you did not leave a trailing slash when you entered it into the security device.
  * **Incorrect:** <https://209437179984.uw2.portal.vectra.ai/>
  * **Correct:** <https://209437179984.uw2.portal.vectra.ai>
* Make sure you entered the Expel Client ID and Secret Key correctly.

If you have lost this information or if it does not work, try setting up a new API client by following the steps in [Step 1](#h_01k36pbzk9nhhzt9202j83n5zb), and then [edit your device](/connect-your-technology/security-devices/manage-security-devices.md#edit-a-security-device) and add the new credentials.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.expel.io/connect-your-technology/q-z-integrations/vectra-ai-ndr-setup-for-workbench.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.