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
* exclude old notifications from search
* sso page updates
* clarify intended docs use
* exclude old notifications from search
* sso page updates
* clarify intended docs use
* rm duplicate api article
---------
Co-authored-by: Paul Osinski <paul.m.osinski@gmail.com>
Copy file name to clipboardExpand all lines: docs/content/en/about_defectdojo/about_docs.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,8 @@ cascade:
19
19
20
20

21
21
22
+
<spanstyle="background-color:rgba(242, 86, 29, 0.3)">DefectDojo Inc. and open-source contributors maintain this documentation to support both the Community and Pro editions of DefectDojo.</span>
23
+
22
24
### What is DefectDojo?
23
25
24
26
DefectDojo is a DevSecOps platform. DefectDojo streamlines DevSecOps by serving as an aggregator and single pane of glass for your security tools. DefectDojo has smart features to enhance and tune the results from your security tools including the ability to merge findings, remember false positives, and distill duplicates. DefectDojo also integrates with JIRA, provides metrics / reports, and can also be used for traditional pen test management.
Copy file name to clipboardExpand all lines: docs/content/en/api/api-v2-docs.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,10 @@ weight: 2
8
8
DefectDojo\'s API is created using [Django Rest
9
9
Framework](http://www.django-rest-framework.org/). The documentation of
10
10
each endpoint is available within each DefectDojo installation at
11
-
[`/api/v2/doc/`](https://demo.defectdojo.org/api/v2/) and can be accessed by choosing the API v2
11
+
[`/api/v2/oa3/swagger-ui`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/)) and can be accessed by choosing the API v2
12
12
Docs link on the user drop down menu in the header.
13
13
14
-

14
+

15
15
16
16
The documentation is generated using [drf-spectacular](https://drf-spectacular.readthedocs.io/) at [`/api/v2/oa3/swagger-ui/`](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/), and is
17
17
interactive. On the top of API v2 docs is a link that generates an OpenAPI v3 spec.
@@ -20,12 +20,12 @@ To interact with the documentation, a valid Authorization header value
20
20
is needed. Visit the `/api/key-v2` view to generate your
21
21
API Key (`Token <api_key>`) and copy the header value provided.
22
22
23
-

23
+

24
24
25
25
Each section allows you to make calls to the API and view the Request
26
26
URL, Response Body, Response Code and Response Headers.
27
27
28
-

28
+

29
29
30
30
If you're logged in to the Defect Dojo web UI, you do not need to provide the authorization token.
31
31
@@ -42,7 +42,7 @@ For example: :
42
42
43
43
### Alternative authentication method
44
44
45
-
If you use [an alternative authentication method](../social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \
45
+
If you use [an alternative authentication method](../archived_docs/integrations/social-authentication/) for users, you may want to disable DefectDojo API tokens because it could bypass your authentication concept. \
46
46
Using of DefectDojo API tokens can be disabled by specifying the environment variable `DD_API_TOKENS_ENABLED` to `False`.
47
47
Or only `api/v2/api-token-auth/` endpoint can be disabled by setting `DD_API_TOKEN_AUTH_ENDPOINT_ENABLED` to `False`.
48
48
@@ -125,7 +125,7 @@ The json object result is: :
125
125
{{< /highlight >}}
126
126
127
127
See [Django Rest Framework\'s documentation on interacting with an
128
-
API](http://www.django-rest-framework.org/topics/api-clients/) for
128
+
API](https://www.django-rest-framework.org/) for
129
129
additional examples and tips.
130
130
131
131
## Manually calling the API
@@ -178,4 +178,4 @@ Example for importing a scan result:
178
178
|[.Net/C# library](https://www.nuget.org/packages/DefectDojo.Api/)| working (2021-06-08) ||
179
179
|[dd-import](https://github.com/MaibornWolff/dd-import)| working (2021-08-24) | dd-import is not directly an API wrapper. It offers some convenience functions to make it easier to import findings and language data from CI/CD pipelines. |
180
180
181
-
Some of the api wrappers contain quite a bit of logic to ease scanning and importing in CI/CD environments. We are in the process of simplifying this by making the DefectDojo API smarter (so api wrappers / script can be dumber).
181
+
Some of the api wrappers contain quite a bit of logic to ease scanning and importing in CI/CD environments. We are in the process of simplifying this by making the DefectDojo API smarter (so api wrappers / script can be dumber).
0 commit comments