You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/organizations/managing-security-and-risk.md
+12-2Lines changed: 12 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -592,14 +592,24 @@ Codacy supports two types of scanning:
592
592
!!! important
593
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)
594
594
595
-
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:
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.
604
+
605
+
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:
596
606
597
607
-**REST APIs**, which require a publicly accessible OpenAPI specification URL.
598
608
-**GraphQL APIs**, where the schema is inferred from the default path `{targetUrl}/graphql`.
599
609
600
610
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).
601
611
602
-
!!! important
612
+
!!! note
603
613
If exposing your API specification isn't feasible for your team, let us know via support or your account representative.
604
614
605
615
#### Avoid running API scans on Production environments
0 commit comments