Skip to content

Commit ff9a413

Browse files
committed
Deployed 220bc2c to . with MkDocs 1.6.1
1 parent b096c10 commit ff9a413

6 files changed

Lines changed: 243 additions & 282 deletions

File tree

codacy-api/examples/triggering-dast-scans/index.html

Lines changed: 8 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
<meta name="description" content="Instructions on how to trigger DAST/App using the API.">
1212

1313

14-
<meta http-equiv="last-modified" content="2025-04-10 13:32:06">
14+
<meta http-equiv="last-modified" content="2025-05-09 08:03:47">
1515

1616

1717
<link rel="canonical" href="https://docs.codacy.com/codacy-api/examples/triggering-dast-scans/">
@@ -4477,9 +4477,8 @@ <h1 id="trigger-dynamic-application-security-testing-dast-scans">Trigger Dynamic
44774477
<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>
44784478
<div class="admonition important">
44794479
<p class="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 <a href="../../../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 <a href="../../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 <a href="../../../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>
44834482
</div>
44844483
<h2 id="creating-targets">Creating targets<a class="headerlink" href="#creating-targets" title="Permanent link">#</a></h2>
44854484
<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).
@@ -4535,7 +4534,7 @@ <h2 id="creating-targets">Creating targets<a class="headerlink" href="#creating-
45354534
<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>
45364535
</li>
45374536
</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>
45394538
<h2 id="trigger-dast-analysis-scans">Trigger DAST analysis scans<a class="headerlink" href="#trigger-dast-analysis-scans" title="Permanent link">#</a></h2>
45404539
<p>Once your targets are created you can trigger an analysis by calling the '<a href="https://api.codacy.com/api/api-docs#analyzedasttarget">Analyze DAST target</a>' endpoint.</p>
45414540
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>https://app.codacy.com/api/v3/organizations/<span class="o">{</span>GIT_PROVIDER<span class="o">}</span>/<span class="o">{</span>ORGANIZATION<span class="o">}</span>/dast/targets/<span class="o">{</span>DAST_TARGET_ID<span class="o">}</span>/analyze<span class="w"> </span><span class="se">\</span>
@@ -4545,47 +4544,9 @@ <h2 id="trigger-dast-analysis-scans">Trigger DAST analysis scans<a class="header
45454544
<p>Replace the placeholders with your own values:</p>
45464545
<ul>
45474546
<li><strong>API_KEY:</strong> <a href="../../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 <a href="./#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 <a href="./#creating-targets">previous section</a>. For example, <code>457</code>. You must have admin permissions over the organization on the Git provider.</li>
45894550
</ul>
45904551
<p>Scans occur asynchronously. To monitor an ongoing scan you can use the <a href="../../../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 &gt; DAST/App scanning</strong>.</p>
45914552

@@ -4744,7 +4705,7 @@ <h3>Share your feedback 📢</h3>
47444705
<div class="md-source-date">
47454706
<small>
47464707

4747-
Last modified <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 10, 2025</span>
4708+
Last modified <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">May 9, 2025</span>
47484709

47494710
</small>
47504711
</div>

0 commit comments

Comments
 (0)