Skip to content

Commit 04f1161

Browse files
committed
adding more information
1 parent 30d0bb0 commit 04f1161

2 files changed

Lines changed: 13 additions & 2 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Before the automation process itself, you need to create a target. Targets are i
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

2121
!!! important
22-
**Do not run API scans on production enviroments** as our API scanners may cause potential downtime.
22+
**Do not run API scans on production enviroments** as our API scanners may cause potential downtime. [Learn more](../../organizations/managing-security-and-risk.md#avoid-running-api-scans-on-production-environments)
2323

2424
To create a target, use the following API request:
2525

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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ Codacy supports two types of scanning:
590590
### Creating an App Scanning target
591591

592592
!!! important
593-
**Do not run API scans on production enviroments** as our API scanners may cause potential downtime.
593+
**Do not run API scans on production enviroments** as our API scanners may cause potential downtime. [Learn more](#avoid-running-api-scans-on-production-environments)
594594

595595
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:
596596

@@ -602,6 +602,17 @@ API targets optionally support **header-based authentication**. As you create a
602602
!!! important
603603
If exposing your API specification isn't feasible for your team, let us know via support or your account representative.
604604

605+
#### Avoid running API scans on Production environments
606+
607+
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.
608+
609+
Depending on how your target environment is configured, this may:
610+
- Trigger rate limiting or throttling
611+
- Appear as a high volume of traffic, similar to a load test
612+
- Lead to incomplete scan results if key endpoints are blocked or limited
613+
614+
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.
615+
605616

606617
### How to scan a target
607618

0 commit comments

Comments
 (0)