Skip to content

Commit 42149ac

Browse files
committed
reviewed formatting
1 parent 6849f38 commit 42149ac

2 files changed

Lines changed: 3 additions & 15 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. [Learn more](../../organizations/managing-security-and-risk.md#avoid-running-api-scans-on-production-environments)
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)
2323

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

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

Lines changed: 2 additions & 14 deletions
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. [Learn more](#avoid-running-api-scans-on-production-environments)
593+
**Do not run API scans on production enviroments as our API scanners may cause potential downtime.**
594594

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

@@ -602,7 +602,7 @@ Codacy supports two types of scanning:
602602

603603
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.
604604

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:
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:
606606

607607
- **REST APIs**, which require a publicly accessible OpenAPI specification URL.
608608
- **GraphQL APIs**, where the schema is inferred from the default path `{targetUrl}/graphql`.
@@ -612,18 +612,6 @@ API targets optionally support **header-based authentication**. As you create a
612612
!!! note
613613
If exposing your API specification isn't feasible for your team, let us know via support or your account representative.
614614

615-
#### Avoid running API scans on Production environments
616-
617-
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.
618-
619-
Depending on how your target environment is configured, this may:
620-
621-
- Trigger rate limiting or throttling
622-
- Appear as a high volume of traffic, similar to a load test
623-
- Lead to incomplete scan results if key endpoints are blocked or limited
624-
625-
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.
626-
627615

628616
### How to scan a target
629617

0 commit comments

Comments
 (0)