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/codacy-api/examples/triggering-dast-scans.md
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -14,9 +14,9 @@ Thanks to the new app scanning capabilities available on the Security and risk m
14
14
15
15
## Creating targets
16
16
17
-
Before the automation process itself, you need to create a target. Targets are individual configurations that define what Codacy will scan, including the target URL, its type (API or web application), and other fields like OpenAPI specification and optional authentication details for API targets.
17
+
Before the automation process itself, you need to create a target. Targets are individual configurations that define what Codacy will scan, including the target URL, its type (API or web application), and other type-dependent fields like OpenAPI specification and optional authentication details for API targets.
18
18
19
-
Targets only need to be created once. Note that **target URLs are immutable** — if you need to change the URL, definition, or authentication, you'll need to delete the target and create a new one.
19
+
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.
20
20
21
21
To create a target, use the following API request:
22
22
@@ -42,7 +42,7 @@ Replace the placeholders with your own values:
42
42
|**API_KEY**| true |[Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API |
43
43
|**GIT_PROVIDER**| true | Git provider hosting of the organization, using one of the values in the table below. <br/>**Options:**`gh` (GitHub Cloud), `ghe`(GitHub Enterprise), `gl` (Gitlab Cloud), `gle` (Gitlab Enterprise), `bb` (Bitbucket Cloud), `bbe` (Bitbucket Server) |
44
44
|**ORGANIZATION**| true | Name of the organization on the Git provider. You must have admin permissions over the organization on the Git provider.<br/>For example, `codacy`|
45
-
|**TARGET_URL**| true | URL of the Web app or API that will be scanned. <br/>Must start with `http://` or `https://`|
45
+
|**TARGET_URL**| true | URL of the Web app or API that will be scanned. <br/>Must start with `http://` or `https://`<br/>For example, `https://api.codacy.com/v1`|
46
46
|**TARGET_TYPE**| false | Type of target to be scanned <br/> **Options:**`webapp` (default), `openapi` or `graphql`|
47
47
|**API_DEFINITION_URL**| false * | The URL to a publicly accessible OpenAPI specification.<br/>*** Required for OpenAPI targets**|
48
48
|**HEADER_NAME**| false | Name of the authentication header. <br/>For example, `Authentication`|
@@ -51,7 +51,7 @@ Replace the placeholders with your own values:
51
51
Once you create the target you'll get the target `id` as a response. You will use it to trigger DAST scans in the next section.
52
52
53
53
!!! important
54
-
Currently we only support one authentication header. If you need more, please let us know via support.
54
+
Currently we only support one authentication header. If you need more, please let us know via support or your account representative.
Copy file name to clipboardExpand all lines: docs/organizations/managing-security-and-risk.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -568,7 +568,7 @@ To access the App scanning page, go to the [Overview page](#dashboard) and click
568
568
569
569

570
570
571
-
App scanning analyzes applications in runtime environments to help identify vulnerabilities such as misconfigurations, insecure authentication, or other security issues that occur in real-world usage. Because it doesn't rely on access to source code, it’s language-agnostic and useful for validating security across your entire stack.
571
+
App scanning analyzes applications in production or production-like environments to help identify vulnerabilities such as misconfigurations, insecure authentication, or other security issues that occur in real-world usage. Because it doesn't rely on access to source code, it’s language-agnostic and useful for validating security across your entire stack.
572
572
573
573
Codacy supports two types of scanning:
574
574
@@ -589,7 +589,7 @@ Codacy supports two types of scanning:
589
589
590
590
## Creating an App Scanning target
591
591
592
-
When creating a scan target, you'll be able to choose between a Web App or an API. Codacy supports scanning for:
592
+
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:
593
593
594
594
-**REST APIs**, which require a publicly accessible OpenAPI specification URL.
595
595
-**GraphQL APIs**, where the schema is inferred from the default path `{targetUrl}/graphql`.
@@ -600,7 +600,7 @@ API targets optionally support **header-based authentication**. As you create a
600
600
Avoid running API scans on production enviroments as our API scanners may cause potential downtime.
601
601
602
602
!!! important
603
-
If exposing your API specification is not feasible for your team, let us know via support or your account representative.
603
+
If exposing your API specification isn't feasible for your team, let us know via support or your account representative.
0 commit comments