# defectdojo/django-defectdojo architecture

> Architecture diagram of the GitHub repository defectdojo/django-defectdojo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/defectdojo/django-defectdojo
- Repository: https://github.com/defectdojo/django-defectdojo

## Overview

DefectDojo is a vulnerability-management and application-security-posture platform. A central workflow is importing security-scan results, reconciling findings and affected locations, then tracking remediation and reporting through the UI or REST API. The graph also preserves API v3 query/export features, authorization, Jira integration, and notifications. Relationships are limited to README statements and SOURCE INDEX references; unsampled implementation details are not asserted.

Main entry points: [`dojo/finding/api_v3/routes.py`](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/api_v3/routes.py) (API v3 routes), [`dojo/importers/location_manager.py`](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/importers/location_manager.py) (Location reconciliation), [`dojo/finding/queries.py`](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/queries.py) (Finding queries), [`dojo/api_v3/import_routes.py`](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/import_routes.py) (Import routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_ingest["Scan ingestion"]
  node_import_api["Import routes<br/>[import_routes.py]"]
  node_import_services["Import services<br/>[services.py]"]
  node_location_import["Location reconciliation"]
end

subgraph group_domain["Vulnerability management"]
  node_finding["Finding services<br/>[services.py]"]
  node_finding_queries["Finding queries<br/>[queries.py]"]
  node_locations["Locations and status<br/>[models.py]"]
  node_location_status["Location status<br/>[status.py]"]
  node_vulnerability["Vulnerability data<br/>[models.py]"]
  node_tags["Tag inheritance<br/>[inheritance.py]"]
  node_db[("Application records<br/>[models.py]")]
end

subgraph group_api["API and access"]
  node_api_v3["API v3 routes<br/>[routes.py]"]
  node_api_filter["Filtering and sorting<br/>[filtering.py]"]
  node_api_page["Pagination<br/>[pagination.py]"]
  node_api_expand["Expanded views<br/>[expand.py]"]
  node_api_include["Included resources<br/>[include.py]"]
  node_api_export["CSV export<br/>[csv_export.py]"]
  node_authorization["Authorization<br/>[authorization.py]"]
  node_roles["Permission definitions"]
end

subgraph group_integrations["Remediation and reporting"]
  node_jira["Jira integration<br/>[services.py]"]
  node_notifications["Notifications<br/>[tasks.py]"]
  node_reports["Reporting<br/>[views.py]"]
end

node_user(("Security team"))
node_scanner{{"Scan tools"}}

node_user -->|"submits scans"| node_import_api
node_scanner -.->|"provides reports"| node_import_api
node_import_api -->|"invokes"| node_import_services
node_import_api -->|"uses services"| node_jira
node_import_services -.->|"coordinates"| node_location_import
node_location_import -->|"reads and updates"| node_locations
node_location_import -->|"applies status"| node_location_status
node_location_import -->|"uses inheritance"| node_tags
node_location_import -.->|"updates records"| node_db
node_finding -.->|"updates records"| node_db
node_finding_queries -->|"queries"| node_locations
node_finding_queries -->|"applies filters"| node_authorization
node_finding_queries -->|"queries"| node_vulnerability
node_api_v3 -->|"applies filters"| node_api_filter
node_api_v3 -->|"paginates"| node_api_page
node_api_v3 -->|"expands results"| node_api_expand
node_api_v3 -->|"includes resources"| node_api_include
node_api_v3 -->|"exports results"| node_api_export
node_api_v3 -->|"checks access"| node_authorization
node_authorization -->|"uses permissions"| node_roles
node_authorization -->|"checks membership"| node_db
node_api_v3 -->|"queries findings"| node_finding_queries
node_api_v3 -->|"uses services"| node_finding
node_user -.->|"queries findings"| node_api_v3
node_user -.->|"views reports"| node_reports
node_finding -.->|"syncs issues"| node_jira
node_user -.->|"tracks remediation"| node_jira
node_user -.->|"receives updates"| node_notifications

click node_import_api "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/import_routes.py"
click node_import_services "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/importers/services.py"
click node_location_import "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/importers/location_manager.py"
click node_finding "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/services.py"
click node_finding_queries "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/queries.py"
click node_locations "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/location/models.py"
click node_location_status "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/location/status.py"
click node_vulnerability "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/vulnerability/models.py"
click node_tags "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/tags/inheritance.py"
click node_db "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/models.py"
click node_api_v3 "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/api_v3/routes.py"
click node_api_filter "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/filtering.py"
click node_api_page "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/pagination.py"
click node_api_expand "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/expand.py"
click node_api_include "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/include.py"
click node_api_export "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/csv_export.py"
click node_authorization "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/authorization/authorization.py"
click node_roles "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/authorization/roles_permissions.py"
click node_jira "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/jira/services.py"
click node_notifications "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/notifications/tasks.py"
click node_reports "https://github.com/defectdojo/django-defectdojo/blob/master/dojo/reports/ui/views.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_import_api,node_import_services,node_location_import toneBlue
class node_finding,node_finding_queries,node_locations,node_location_status,node_vulnerability,node_tags,node_db toneAmber
class node_api_v3,node_api_filter,node_api_page,node_api_expand,node_api_include,node_api_export,node_authorization,node_roles toneMint
class node_jira,node_notifications,node_reports toneRose
class node_user,node_scanner toneIndigo
```

## Components

### Scan ingestion

- [Import routes](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/import_routes.py): `dojo/api_v3/import_routes.py`
- [Import services](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/importers/services.py): `dojo/importers/services.py`
- [Location reconciliation](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/importers/location_manager.py): `dojo/importers/location_manager.py`

### Vulnerability management

- [Finding services](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/services.py): `dojo/finding/services.py`
- [Finding queries](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/queries.py): `dojo/finding/queries.py`
- [Locations and status](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/location/models.py): `dojo/location/models.py`
- [Location status](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/location/status.py): `dojo/location/status.py`
- [Vulnerability data](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/vulnerability/models.py): `dojo/vulnerability/models.py`
- [Tag inheritance](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/tags/inheritance.py): `dojo/tags/inheritance.py`
- [Application records](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/models.py): `dojo/models.py`

### API and access

- [API v3 routes](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/finding/api_v3/routes.py): `dojo/finding/api_v3/routes.py`
- [Filtering and sorting](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/filtering.py): `dojo/api_v3/filtering.py`
- [Pagination](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/pagination.py): `dojo/api_v3/pagination.py`
- [Expanded views](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/expand.py): `dojo/api_v3/expand.py`
- [Included resources](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/include.py): `dojo/api_v3/include.py`
- [CSV export](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/api_v3/csv_export.py): `dojo/api_v3/csv_export.py`
- [Authorization](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/authorization/authorization.py): `dojo/authorization/authorization.py`
- [Permission definitions](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/authorization/roles_permissions.py): `dojo/authorization/roles_permissions.py`

### Remediation and reporting

- [Jira integration](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/jira/services.py): `dojo/jira/services.py`
- [Notifications](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/notifications/tasks.py): `dojo/notifications/tasks.py`
- [Reporting](https://github.com/defectdojo/django-defectdojo/blob/master/dojo/reports/ui/views.py): `dojo/reports/ui/views.py`

### Other components

- **Security team**
- **Scan tools**

## Connections

- Security team → Import routes: submits scans (evidence: `README.md`)
- Scan tools → Import routes: provides reports
- Import routes → Import services: invokes (evidence: `dojo/api_v3/import_routes.py`)
- Import routes → Jira integration: uses services (evidence: `dojo/api_v3/import_routes.py`)
- Import services → Location reconciliation: coordinates
- Location reconciliation → Locations and status: reads and updates (evidence: `dojo/importers/location_manager.py`)
- Location reconciliation → Location status: applies status (evidence: `dojo/importers/location_manager.py`)
- Location reconciliation → Tag inheritance: uses inheritance (evidence: `dojo/importers/location_manager.py`)
- Location reconciliation → Application records: updates records (evidence: `dojo/importers/location_manager.py`)
- Finding services → Application records: updates records
- Finding queries → Locations and status: queries (evidence: `dojo/finding/queries.py`)
- Finding queries → Authorization: applies filters (evidence: `dojo/finding/queries.py`)
- Finding queries → Vulnerability data: queries (evidence: `dojo/finding/queries.py`)
- API v3 routes → Filtering and sorting: applies filters (evidence: `dojo/finding/api_v3/routes.py`)
- API v3 routes → Pagination: paginates (evidence: `dojo/finding/api_v3/routes.py`)
- API v3 routes → Expanded views: expands results (evidence: `dojo/finding/api_v3/routes.py`)
- API v3 routes → Included resources: includes resources (evidence: `dojo/finding/api_v3/routes.py`)
- API v3 routes → CSV export: exports results (evidence: `dojo/finding/api_v3/routes.py`)
- API v3 routes → Authorization: checks access (evidence: `dojo/finding/api_v3/routes.py`)
- Authorization → Permission definitions: uses permissions (evidence: `dojo/authorization/authorization.py`)
- Authorization → Application records: checks membership (evidence: `dojo/authorization/authorization.py`)
- API v3 routes → Finding queries: queries findings (evidence: `dojo/finding/api_v3/routes.py`)
- API v3 routes → Finding services: uses services (evidence: `dojo/finding/api_v3/routes.py`)
- Security team → API v3 routes: queries findings
- Security team → Reporting: views reports
- Finding services → Jira integration: syncs issues
- Security team → Jira integration: tracks remediation
- Security team → Notifications: receives updates
