Skip to content

Commit a9fd662

Browse files
chore: clarify api scan risks (#2419)
* Highlight message * adding more information * formatting * testing some stuff * reviewed formatting * also review api alert
1 parent bb268e7 commit a9fd662

2 files changed

Lines changed: 28 additions & 5 deletions

File tree

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,19 @@ Before the automation process itself, you need to create a target. Targets are i
1818

1919
Targets only need to be created once. Note that **targets are immutable** — if you need to change the URL, definition, or authentication, you'll need to delete the target and create a new one.
2020

21+
!!! important
22+
**Do not run API scans on production enviroments as our API scanners may cause potential downtime.**
23+
24+
Our DAST API scanner performs active security testing by sending a large number of requests to your application. When using authenticated API scanning, this activity can be even more intensive, as ZAP explores and probes more of your API surface.
25+
26+
Depending on how your target environment is configured, this may:
27+
28+
- Trigger rate limiting or throttling
29+
- Appear as a high volume of traffic, similar to a load test
30+
- Lead to incomplete scan results if key endpoints are blocked or limited
31+
32+
We recommend running scans in a **test or staging environment**, or coordinating with your infrastructure team to ensure that your environment can safely handle the load.
33+
2134
To create a target, use the following API request:
2235

2336
```bash

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

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -587,7 +587,20 @@ Codacy supports two types of scanning:
587587
!!! note
588588
Already using ZAP? [Upload your results via the API.](../codacy-api/examples/uploading-dast-results.md)
589589

590-
## Creating an App Scanning target
590+
### Creating an App Scanning target
591+
592+
!!! important
593+
**Do not run API scans on production enviroments as our API scanners may cause potential downtime.**
594+
595+
Our DAST API scanner performs active security testing by sending a large number of requests to your application. When using authenticated API scanning, this activity can be even more intensive, as ZAP explores and probes more of your API surface.
596+
597+
Depending on how your target environment is configured, this may:
598+
599+
- Trigger rate limiting or throttling
600+
- Appear as a high volume of traffic, similar to a load test
601+
- Lead to incomplete scan results if key endpoints are blocked or limited
602+
603+
We recommend running scans in a **test or staging environment**, or coordinating with your infrastructure team to ensure that your environment can safely handle the load.
591604

592605
When creating a scan target, you'll be able to choose between a Web App or an API. Configuring a Web App will only require a target URL, while APIs will have other requirements:
593606

@@ -596,10 +609,7 @@ When creating a scan target, you'll be able to choose between a Web App or an AP
596609

597610
API targets optionally support **header-based authentication**. As you create a target, keep in mind you may not be able to view or change certain fields later (to change your configurations you may need to delete and create a new target).
598611

599-
!!! important
600-
Avoid running API scans on production enviroments as our API scanners may cause potential downtime.
601-
602-
!!! important
612+
!!! note
603613
If exposing your API specification isn't feasible for your team, let us know via support or your account representative.
604614

605615

0 commit comments

Comments
 (0)