---
title: "Nucleus"
slug: "nucleus"
updated: 2026-06-11T13:46:22Z
published: 2026-06-11T13:46:22Z
canonical: "docs.databee.buzz/nucleus"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.databee.buzz/llms.txt
> Use this file to discover all available pages before exploring further.

# Nucleus

Nucleus helps organizations centralize and manage vulnerability data from multiple security and infrastructure tools through a unified platform. Refer to Nucleus Security [official documentation](https://nucleussec.com/).

**Integration Method:** API and S3

**Tables**: Device Inventory Info (5001), Software Inventory Info (5020), Assessment Finding (99402001), Vulnerability Finding Info (2002)

This integration supports the following events.

| **Event** | **Description** |
| --- | --- |
| Projects | Get detailed information about all the Projects with the overall Risk Scores of the projects. |
| Assets | Get detailed information about all Assets. |
| Softwares | Get detailed information about all the Software. |
| Assessments | Get detailed information about all the Assessments. |
| Vulnerability Findings | Get detailed information about all the Vulnerabilities |

> [!NOTE]
> **Note**:
> 
> To ingest all event types, two separate feeds must be deployed. Vulnerability Findings is only available via S3 and other events are only available via API. For S3 ingestion configuration, refer to the [linked datasource](https://docs.databee.buzz/docs/amazon-s3) configuration documentation. First, configure the S3 ingestion datasource. Then, configure Vulnerability Findings data export and S3 bucket forwarding in Nucleus as described in the [official documentation](https://help.nucleussec.com/docs/s3-data-upload) for all the projects of which Vulnerability Findings data is required to be forwarded. Only the default JSON-based forwarding format is supported. ZIP-compressed forwarding is not supported.

This integration supports the following versions.

| Nucleus API version | v1.0 |
| --- | --- |

> [!NOTE]
> **Note:**
> 
> The Nucleus API ingestion method supports only Projects, Assets, Softwares and Assessments data collection. The Nucleus S3 ingestion method supports only Vulnerability Findings data collection. To ingest all event types, at least two Nucleus feeds are needed.

## Prerequisites

- The user should have org admin access role in the Nucleus to Create [Custom Nucleus Role](/docs/nucleus#create_custom_nucleus_role) and [API account](/docs/nucleus#create_api_account) with the role.
- The user should have access to the DataBee console.

## Configuration Overview

1. Create [Custom Nucleus Role](/docs/nucleus#create_custom_nucleus_role) with required permissions and generate API token using [API account](/docs/nucleus#create_api_account) creation with mentioned custom role in Nucleus.
2. Add the [Nucleus feed](/docs/nucleus#databee_configuration) in the DataBee console with the below parameters.

| **DataBee Parameter** | **Nucleus Parameter** |
| --- | --- |
| API Bearer Token | [API Token](/docs/nucleus#api_key) |
| API Base URL | Base URL for Nucleus API |

## Nucleus Configuration

## 

### Create Custom Nucleus Role

1. Log in to **Nucleus** Platform with **Org Admin** user.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-dzb3jsao.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
2. Navigate to the left **Navigation Menu** > **Administration** > **Roles**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-ne14fhj4.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
3. Click on **+ Add Role** button. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-7uy1unvf.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
4. Select **Organization** in which role needs to be created, **Name** of the role and the **Description.** And keep the **Name** of role handy for creating [API Account](/docs/nucleus#create_api_account).

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-3i5er2jc.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
5. The following **Permissions** needs to be checked for a Role to fetch the data properly:

| **Section** | **Permission** |
| --- | --- |
| API | API Access |
| Assessments | View All Assessments |
| Assets | View Assets |
| Projects | Read Projects |
6. Select **API Access** Permission.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-b5x26ra1.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
7. Select **View All Assessments** Permission.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-etdbsico.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
8. Select **View Assets** Permission.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-tbqk351k.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
9. Select **Read Project** Permission.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-kc3be1l4.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
10. Click on the **Save** button. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-n6mh8dwy.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)

### Create API Account

1. Log in to **Nucleus** Platform with **Org Admin** user.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-cv8dddrw.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
2. Navigate to the left **Navigation Menu** > **Administration** > **Users**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-8v9i2pbk.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
3. Click on **Add API Account** **button**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-abgle0m0.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
4. Select **Organization** in which the [custom role](/docs/nucleus#create_custom_nucleus_role) was created and enter the **API Account Username**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-849kql27.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
5. **Select Project(s)** for which the data needs to be ingested in DataBee.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-s3no1dwd.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
6. For each selected project, select [Role](/docs/nucleus#role_name) created earlier.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-9mns89mi.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
7. Click the **Create Account** button.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-t6dzlp0n.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
8. Once an API account is created, **View API Key for Account** action button for the created account.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-z08r0ar8.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
9. Click on **Show API Key**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-qynez3q5.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
10. Copy **API key**.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-96y6mcws.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)

> [!NOTE]
> **Note**:
> 
> Keep the copied API key handy as it will be useful while configuring the Nucleus datasource in the Databee platform.

## DataBee Configuration

1. Login to the DataBee UI, navigate to **Data** > **Data Feeds** and click the **Add New Data Feed** button. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-gv7adlfi.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
2. Search for **Nucleus** and click it as shown below. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-astwcwqv.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
3. Click on the **API Ingest** option for the collection method. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-dpmrqv5v.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
4. Enter **feed contact information**. ![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-dlpk5f6s.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
5. In the next dialog, enter the following:

> [!NOTE]
> **Note**:
> 
> Locate the Nucleus UI URL (for example, https://nucleus-test.nucleussec.com/). The <instance> value from the URL (**nucleus-test** in this example) should be entered in the **API Base URL** field.

> [!NOTE]
> **Note:**
> 
> The Projects event type is mandatory for configuring all other event types (i.e. Asset, Software and Assessment) and is therefore non-editable in the UI.
  - **Authorization Method:** Bearer Token
  - **API Base URL**: Replace **<instance>** with your Nucleus instance
  - **Token**: Paste the [API Key](/docs/nucleus#api_key)
  - **Event Types**: Preselected for all the event types that integration pulls.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-vtjykkib.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
6. Click on the **Test Connection** button once details are added.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-fi32hwyi.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)
7. Click on the **Submit** button once Test Connection is successful.

![](https://cdn.document360.io/04e48772-4346-44a4-aa69-043eca42257c/Images/Documentation/nucleus-image-uw82ubxd.png?sv=2026-02-06&spr=https&st=2026-10-30T11%3A27%3A22Z&se=2026-10-30T12%3A27%3A22Z&sr=c&sp=r&sig=4THmL959u6f2iGycGywsvNPzzy%2Bnl4vIF6kc%2FSjbl5Q%3D)

# 

## Troubleshooting Tips

- If you are facing **400** response code, this might be possibly due to an incorrect API token. Ensure the token is pasted correctly.
- If you are facing **403** response code, this might be possibly due to missing permissions. Check that Nucleus custom Role has the necessary [permissions](/docs/nucleus#permissions). If needed, update the Role permissions using the Nucleus platform, save the changes, and retry the integration.
- If you are not seeing data for any specific project even if it is available in the Nucleus, check for the project is [added](/docs/nucleus#projects) correctly with the required custom role.