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
<p>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.</p>
4478
4478
<divclass="admonition important">
4479
4479
<pclass="admonition-title">Important</p>
4480
-
<p>App scanning is a business feature. If you are a Codacy Pro customer, contact our customer success team to access a short trial.
4481
-
Check your <ahref="../../../organizations/roles-and-permissions-for-organizations/">permissions</a>. Only git provider admins and organization managers will be able to create new targets and trigger scans (in app and via the API).
4482
-
Get your API key. All the methods below require you to authenticate via your <ahref="../../api-tokens/#account-api-tokens">account's API token</a>.</p>
4480
+
<p><strong>App scanning is a business feature.</strong> If you are a Codacy Pro customer, contact our customer success team to access a short trial.</p>
4481
+
<p><strong>Check your <ahref="../../../organizations/roles-and-permissions-for-organizations/">permissions</a>.</strong> Only git provider admins and organization managers will be able to create new targets and trigger scans (in app and via the API).</p>
<p>Before the automation process itself, you need to create a target. Targets are single units that contain all the configurations of your scan, in this case the URL (and later on other configurations, like authentication details and OpenAPI definition).
<p><strong>ORGANIZATION:</strong> Name of the organization on the Git provider. For example, <code>codacy</code>. You must have admin permissions over the organization on the Git provider.</p>
4536
4535
</li>
4537
4536
</ul>
4538
-
<p>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.</p>
4537
+
<p>Once you create the target you'll get the target <code>id</code> as a response. You will use it to trigger DAST scans in the next section.</p>
<p>Once your targets are created you can trigger an analysis by calling the '<ahref="https://api.codacy.com/api/api-docs#analyzedasttarget">Analyze DAST target</a>' endpoint.</p>
<p>Replace the placeholders with your own values:</p>
4546
4545
<ul>
4547
4546
<li><strong>API_KEY:</strong><ahref="../../api-tokens/#account-api-tokens">Account API token</a> used to authenticate on the Codacy API.</li>
4548
-
<li>
4549
-
<p><strong>GIT_PROVIDER:</strong> Git provider hosting of the organization, using one of the values in the table below. For example, <code>gh</code> for GitHub Cloud.</p>
4550
-
<table>
4551
-
<thead>
4552
-
<tr>
4553
-
<th>Value</th>
4554
-
<th>Git provider</th>
4555
-
</tr>
4556
-
</thead>
4557
-
<tbody>
4558
-
<tr>
4559
-
<td><code>gh</code></td>
4560
-
<td>GitHub Cloud</td>
4561
-
</tr>
4562
-
<tr>
4563
-
<td><code>ghe</code></td>
4564
-
<td>GitHub Enterprise</td>
4565
-
</tr>
4566
-
<tr>
4567
-
<td><code>gl</code></td>
4568
-
<td>GitLab Cloud</td>
4569
-
</tr>
4570
-
<tr>
4571
-
<td><code>gle</code></td>
4572
-
<td>GitLab Enterprise</td>
4573
-
</tr>
4574
-
<tr>
4575
-
<td><code>bb</code></td>
4576
-
<td>Bitbucket Cloud</td>
4577
-
</tr>
4578
-
<tr>
4579
-
<td><code>bbe</code></td>
4580
-
<td>Bitbucket Server</td>
4581
-
</tr>
4582
-
</tbody>
4583
-
</table>
4584
-
</li>
4585
-
<li>
4586
-
<p><strong>ORGANIZATION:</strong> Name of the organization on the Git provider. For example, <code>codacy</code>. You must have admin permissions over the organization on the Git provider.
4587
-
<strong>DAST_TARGET_ID:</strong> Identifier of a DAST target to analyze (obtained in the <ahref="./#creating-targets">previous section</a>. For example, <code>457</code>. You must have admin permissions over the organization on the Git provider.</p>
4588
-
</li>
4547
+
<li><strong>GIT_PROVIDER:</strong> Git provider hosting of the organization (check the table on the example above). For example, <code>gh</code> for GitHub Cloud.</li>
4548
+
<li><strong>ORGANIZATION:</strong> Name of the organization on the Git provider. For example, <code>codacy</code>. You must have admin permissions over the organization on the Git provider.</li>
4549
+
<li><strong>DAST_TARGET_ID:</strong> Identifier of a DAST target to analyze (obtained in the <ahref="./#creating-targets">previous section</a>. For example, <code>457</code>. You must have admin permissions over the organization on the Git provider.</li>
4589
4550
</ul>
4590
4551
<p>Scans occur asynchronously. To monitor an ongoing scan you can use the <ahref="../../../organizations/managing-security-and-risk/#app-scanning">target management page in Codacy</a>. Once completed, you can access all scan results by navigating to the <strong>Security dashboard</strong>, selecting the <strong>Findings tab</strong> and filtering by <strong>Scan types > DAST/App scanning</strong>.</p>
4591
4552
@@ -4744,7 +4705,7 @@ <h3>Share your feedback 📢</h3>
4744
4705
<divclass="md-source-date">
4745
4706
<small>
4746
4707
4747
-
Last modified <spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 10, 2025</span>
4708
+
Last modified <spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 9, 2025</span>
0 commit comments