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
+9-21Lines changed: 9 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,31 +40,19 @@ Replace the placeholders with your own values:
40
40
| Field | Required | Description |
41
41
|-------|----------|-------------|
42
42
|**API_KEY**| true |[Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API. |
43
-
|**GIT_PROVIDER**| true | Git provider hosting of the organization, using one of the values in the table below. For example, `gh` for GitHub Cloud. Check reference below.|
44
-
|**ORGANIZATION**| true | Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.|
45
-
|**TARGET_URL**| true | Url of the Web app or API that will be scanned. Should start with `http://` or `https://`|
43
+
|**GIT_PROVIDER**| true | Git provider hosting of the organization, using one of the values in the table below. For example, `gh` for GitHub Cloud. <br/>Options: `gh` (GitHub Cloud), `ghe`(GitHub Enterprise), `gl` (Gitlab Cloud), `gle` (Gitlab Enterprise), `bb` (Bitbucket Cloud), `bbe` (Bitbucket Server) |
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://`|
46
46
|**TARGET_TYPE**| false | Type of target to be scanned <br/> Options: `webapp` (default), `openapi` or `graphql`|
47
-
|**API_DEFINITION_URL**| false * | The URL to a publicly accessible OpenAPI specification.<br/> ** * - Required for OpenAPI targets.**|
| **HEADER_VALUE** | false | Authentication parameter value. (example, a Token or API key)
50
-
51
-
-**API_KEY:**[Account API token](../api-tokens.md#account-api-tokens) used to authenticate on the Codacy API.
52
-
-**GIT_PROVIDER:** Git provider hosting of the organization, using one of the values in the table below. For example, `gh` for GitHub Cloud.
53
-
54
-
| Value | Git provider |
55
-
|-------|-------------------|
56
-
|`gh`| GitHub Cloud |
57
-
|`ghe`| GitHub Enterprise |
58
-
|`gl`| GitLab Cloud |
59
-
|`gle`| GitLab Enterprise |
60
-
|`bb`| Bitbucket Cloud |
61
-
|`bbe`| Bitbucket Server |
62
-
63
-
-**ORGANIZATION:** Name of the organization on the Git provider. For example, `codacy`. You must have admin permissions over the organization on the Git provider.
64
-
-
47
+
|**API_DEFINITION_URL**| false * | The URL to a publicly accessible OpenAPI specification.<br/>*** - Required for OpenAPI targets.**|
48
+
|**HEADER_NAME**| false | Authentication parameter name. <br/>For example, `Authentication`)|
49
+
|**HEADER_VALUE**| false | Authentication parameter value. <br/>For example, a token or API key|
65
50
66
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.
67
52
53
+
!!! important
54
+
Currently we only support one authentication header. If you need more, please let us know via support.
55
+
68
56
## Trigger DAST analysis scans
69
57
70
58
Once your targets are created you can trigger an analysis by calling the '[Analyze DAST target](https://api.codacy.com/api/api-docs#analyzedasttarget)' endpoint.
0 commit comments