Skip to content

Commit dd539d5

Browse files
Add dast filter doc [LK-1628] (#2490)
* feat: Add documentation for filtering results per DAST target * feat: Add documentation for filtering results per DAST target
1 parent 44d1ba2 commit dd539d5

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

docs/codacy-api/examples/triggering-dast-scans.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,4 +83,11 @@ Replace the placeholders with your own values:
8383
- **ORGANIZATION:** Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.
8484
- **DAST_TARGET_ID:** Identifier of a DAST target to analyze (obtained in the [previous section](./triggering-dast-scans.md#creating-targets). For example, `457`. You must have admin permissions over the organization on the Git provider.
8585

86-
Scans occur asynchronously. To monitor an ongoing scan you can use the [target management page in Codacy](../../organizations/managing-security-and-risk.md#app-scanning). Once completed, you can access all scan results by navigating to the **Security dashboard**, selecting the **Findings tab** and filtering by **Scan types > DAST/App scanning**.
86+
Scans occur asynchronously. To monitor an ongoing scan you can use the [target management page in Codacy](../../organizations/managing-security-and-risk.md#app-scanning). Once completed, you can access all scan results by navigating to the **Security dashboard**, selecting the **Findings tab** and filtering by **Scan types > DAST/App scanning**, or by clicking on a configured target to expand all of that target's results.
87+
Additionaly, you can use the `SearchSRMItems` endpoint to filter findings by their DAST target URL with the following request:
88+
```bash
89+
curl -X POST https://app.codacy.com/api/v3/organizations/gh/codacy/security/items/search \
90+
-H "Accept: application/json" \
91+
-H "api-token: {API_KEY}" \
92+
-d '{"statuses":["OnTrack","Overdue","DueSoon"],"dastTargetUrls":["example.com]}'
93+
```
211 KB
Loading

docs/organizations/managing-security-and-risk.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -643,4 +643,11 @@ Once a scan completes, results will be available under the **Findings** tab. Use
643643
!!! note
644644
Currently, DAST findings are only visible to admin and organization admin roles.
645645

646+
### Findings results for your DAST scans
647+
648+
As previously mentioned, once a scan completes, results will be available under the **Findings** tab. Use the **Scan types > DAST/App scanning** filter to view relevant findings.
649+
Additionaly, you can click on a configured target to expand all of that target's results.
650+
651+
![DAST target results](images/security-risk-management-app-scanning-see-results.png)
652+
646653
Follow our [roadmap](https://roadmap.codacy.com) for updates on this feature.

0 commit comments

Comments
 (0)