Skip to content

Commit ff945af

Browse files
authored
[docs] add Connectors documentation, 2.55.4 changelog (#14381)
* add new connectors to docs * update changelog for 2.55.4 * update Jfrog with token scopes
1 parent 65fb9df commit ff945af

4 files changed

Lines changed: 50 additions & 1 deletion

File tree

docs/content/import_data/import_intro/comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ There are two main ways that DefectDojo can upload Finding reports.
2828

2929
| | **UI Import** | **API** | **Connectors** <span style="background-color:rgba(242, 86, 29, 0.3)">(Pro)</span> | **Smart Upload** <span style="background-color:rgba(242, 86, 29, 0.3)">(Pro)</span>|
3030
| --- | --- | --- | --- | --- |
31-
| **Supported Scan Types** | All: see [Supported Tools](/supported_tools/) | All: see [Supported Tools](/supported_tools/) | Anchore, AWS Security Hub, BurpSuite, Checkmarx ONE, Dependency-Track, Probely, Semgrep, SonarQube, Snyk, Tenable, Wiz | Nexpose, NMap, OpenVas, Qualys, Tenable |
31+
| **Supported Scan Types** | All: see [Supported Tools](/supported_tools/) | All: see [Supported Tools](/supported_tools/) | Akamai API Security, Anchore, AWS Security Hub, BurpSuite, Checkmarx ONE, Dependency-Track, JFrog Xray, Probely, Semgrep, SonarQube, Snyk, Tenable, Wiz | Nexpose, NMap, OpenVas, Qualys, Tenable |
3232
| **Automation?** | Available via API: `/reimport` `/import` endpoints | Triggered from [CLI Tools](/import_data/pro/specialized_import/external_tools/) or external code | Connectors is an inherently automated feature | Available via API: `/smart_upload_import` endpoint |
3333

3434
### Product Hierarchy and organization

docs/content/import_data/pro/connectors/about_connectors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,13 @@ But everyone needs a starting point, and that's where Connectors come in. Connec
2626

2727
We currently support Connectors for the following tools, with more on the way:
2828

29+
* **Akamai API Security**
2930
* **Anchore**
3031
* **AWS Security Hub**
3132
* **BurpSuite**
3233
* **Checkmarx ONE**
3334
* **Dependency\-Track**
35+
* **JFrog Xray**
3436
* **Probely**
3537
* **Semgrep**
3638
* **SonarQube**

docs/content/import_data/pro/connectors/connectors_tool_reference.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,21 @@ Whenever possible, we recommend creating a new 'DefectDojo Bot' account within y
2121

2222
# **Supported Connectors**
2323

24+
## **Akamai API Security**
25+
26+
The Akamai API Security connector uses an API key to pull security findings from the Akamai API. DefectDojo will discover your Akamai environment and create separate Records for each **Application** and **Host** configured in your account.
27+
28+
#### Prerequisites
29+
30+
You will need an API key with access to the Akamai API. We recommend creating a dedicated service account for DefectDojo to clearly distinguish automated activity from manual team actions.
31+
32+
#### Connector Mappings
33+
34+
1. Enter your Akamai API base URL in the **Location** field. This URL is specific to your Akamai instance: for example
35+
2. Enter a valid **API Key** in the **Secret** field.
36+
37+
DefectDojo will map **Applications** and **Hosts** as separate Records. Each Application will appear as `{name} (application)` and each Host as `{name} (host)` in your Records list.
38+
2439
## **Anchore**
2540

2641
The Anchore connector uses a user's API token to pull data from Anchore Enterprise. Products will be mapped and discovered based on "Applications", which are composed of multiple Images in Anchore - see [Anchore Enterprise Documentation](https://docs.anchore.com/current/docs/sbom_management/application_groups/application_management_anchorectl/) for more information.
@@ -133,6 +148,32 @@ To generate a Dependency\-Track API key:
133148

134149
For more information, see **[Dependency\-Track Documentation](https://docs.dependencytrack.org/integrations/rest-api/)**.
135150

151+
## **JFrog Xray**
152+
153+
The JFrog Xray connector uses the JFrog Xray REST API to fetch vulnerability data from your Artifactory repositories. DefectDojo will discover all repositories in your JFrog instance and generate vulnerability reports via Xray, importing findings on a scheduled basis.
154+
155+
#### Prerequisites
156+
157+
You will need an API token with access to both Artifactory and Xray APIs. We recommend creating a dedicated service account for DefectDojo. The account requires:
158+
159+
* Read access to Artifactory repositories
160+
* Permission to generate and view Xray vulnerability reports (`Apply on Watches` permission in Xray, or equivalent)
161+
162+
#### Connector Mappings
163+
164+
1. Enter your JFrog instance base URL in the **Location** field. This should be the root URL of your JFrog instance, for example `https://your-instance.jfrog.io`. Do not include a trailing path — DefectDojo will construct the appropriate API paths automatically.
165+
2. Enter a valid **Reference Token** in the **Secret** field. Tokens can be generated under **User Management \> Access Tokens** in the JFrog Platform UI.
166+
You'll need to generate a **Reference Token** and use that value.
167+
168+
Required token scopes for JFrog Xray:
169+
170+
- **All Services**, as DefectDojo needs access to both access to both XRay and Artifactory services
171+
- **Manage Reports + Manage Resources** at a minimum.
172+
173+
DefectDojo maps each Artifactory **repository** as a separate Record. On first Sync, DefectDojo generates a full historical vulnerability report; subsequent Syncs generate incremental (delta) reports covering new findings since the last Sync.
174+
175+
See the [JFrog Xray REST API documentation](https://jfrog.com/help/r/jfrog-rest-apis/xray-rest-apis) for more information.
176+
136177
## Probely
137178

138179
This connector uses the Probely REST API to fetch data.

docs/content/releases/pro/changelog.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ For Open Source release notes, please see the [Releases page on GitHub](https://
1212

1313
## Feb 2026: v2.55
1414

15+
### Feb 24, 2026: v2.55.4
16+
17+
* **(Connectors)** Added Akamai API Security, JFrog Xray to Connectors.
18+
* **(Surveys)** Anonymous surveys: users can now access surveys without logging in when anonymous surveys are enabled.
19+
* **(Pro UI)** The Pro UI editor now uses Markdown-based editing for text fields. This resolves issues with HTML-string encoding, especially when Findings were manually entered or edited.
20+
1521
### Feb 17, 2026: v2.55.3
1622

1723
* **(Pro UI)** Added “Scheduled” status to Engagements to enhances the tracking and management of Engagements.

0 commit comments

Comments
 (0)