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
+7-16Lines changed: 7 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,10 @@ description: Instructions on how to trigger DAST/App using the API.
7
7
Thanks to the new app scanning capabilities available on the Security and risk management dashboard, it's now possible to automate application scanning via Codacy's API. This means that, with little effort, you'll be able to trigger app scanning on demand every time you deploy a new version of your app.
8
8
9
9
!!! important
10
-
App scanning is a business feature. If you are a Codacy Pro customer, contact our customer success team to access a short trial.
11
-
Check your [permissions](../../organizations/roles-and-permissions-for-organizations.md). Only git provider admins and organization managers will be able to create new targets and trigger scans (in app and via the API).
12
-
Get your API key. All the methods below require you to authenticate via your [account's API token](../api-tokens.md#account-api-tokens).
10
+
**App scanning is a business feature.** If you are a Codacy Pro customer, contact our customer success team to access a short trial.
11
+
12
+
**Check your [permissions](../../organizations/roles-and-permissions-for-organizations.md).** Only git provider admins and organization managers will be able to create new targets and trigger scans (in app and via the API).
13
+
13
14
14
15
## Creating targets
15
16
@@ -42,7 +43,7 @@ Replace the placeholders with your own values:
42
43
43
44
-**ORGANIZATION:** Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.
44
45
45
-
Once you create the target you'll get the 'Target Id' as a response. That id will be used to trigger DAST scans in the next section.
46
+
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.
46
47
47
48
## Trigger DAST analysis scans
48
49
@@ -57,18 +58,8 @@ curl -X POST https://app.codacy.com/api/v3/organizations/{GIT_PROVIDER}/{ORGANIZ
57
58
Replace the placeholders with your own values:
58
59
59
60
-**API_KEY:**[Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
60
-
-**GIT_PROVIDER:** Git provider hosting of the organization, using one of the values in the table below. For example, `gh` for GitHub Cloud.
61
-
62
-
| Value | Git provider |
63
-
|-------|-------------------|
64
-
|`gh`| GitHub Cloud |
65
-
|`ghe`| GitHub Enterprise |
66
-
|`gl`| GitLab Cloud |
67
-
|`gle`| GitLab Enterprise |
68
-
|`bb`| Bitbucket Cloud |
69
-
|`bbe`| Bitbucket Server |
70
-
61
+
-**GIT_PROVIDER:** Git provider hosting of the organization (check the table on the example above). For example, `gh` for GitHub Cloud.
71
62
-**ORGANIZATION:** Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.
72
-
**DAST_TARGET_ID:** Identifier of a DAST target to analyze (obtained in the [previous section](./triggering-dast-scans.md#creating-targets). For example, `457`. You must have admin permissions over the organization on the Git provider.
63
+
-**DAST_TARGET_ID:** Identifier of a DAST target to analyze (obtained in the [previous section](./triggering-dast-scans.md#creating-targets). For example, `457`. You must have admin permissions over the organization on the Git provider.
73
64
74
65
Scans occur asynchronously. To monitor an ongoing scan you can use the [target management page in Codacy](../../organizations/managing-security-and-risk.md#app-scanning). Once completed, you can access all scan results by navigating to the **Security dashboard**, selecting the **Findings tab** and filtering by **Scan types > DAST/App scanning**.
0 commit comments