Skip to content

Add dast filter doc [LK-1628] #2490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2025
Merged

Add dast filter doc [LK-1628] #2490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2b15c82
feat: Add documentation for filtering results per DAST target
lventura-codacy Sep 30, 2025
33ecc2c
feat: Add documentation for filtering results per DAST target
lventura-codacy Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/codacy-api/examples/triggering-dast-scans.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,11 @@
- **ORGANIZATION:** Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.
- **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.

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**.
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.

Check warning on line 86 in docs/codacy-api/examples/triggering-dast-scans.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Wordiness] Consider using 'all' instead of 'all of'.

Raw Output:
{"message": "[Microsoft.Wordiness] Consider using 'all' instead of 'all of'.", "location": {"path": "docs/codacy-api/examples/triggering-dast-scans.md", "range": {"start": {"line": 86, "column": 397}}}, "severity": "WARNING"}
Additionaly, you can use the `SearchSRMItems` endpoint to filter findings by their DAST target URL with the following request:

Check failure on line 87 in docs/codacy-api/examples/triggering-dast-scans.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Additionaly'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Additionaly'?", "location": {"path": "docs/codacy-api/examples/triggering-dast-scans.md", "range": {"start": {"line": 87, "column": 1}}}, "severity": "ERROR"}
```bash
curl -X POST https://app.codacy.com/api/v3/organizations/gh/codacy/security/items/search \
-H "Accept: application/json" \
-H "api-token: {API_KEY}" \
-d '{"statuses":["OnTrack","Overdue","DueSoon"],"dastTargetUrls":["example.com]}'
```
Binary file added docs/organizations/images/security-risk-management-app-scanning-see-results.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/organizations/managing-security-and-risk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -643,4 +643,11 @@ Once a scan completes, results will be available under the **Findings** tab. Use
!!! note
Currently, DAST findings are only visible to admin and organization admin roles.

### Findings results for your DAST scans

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.
Additionaly, you can click on a configured target to expand all of that target's results.

![DAST target results](images/security-risk-management-app-scanning-see-results.png)

Follow our [roadmap](https://roadmap.codacy.com) for updates on this feature.
Loading