DefectDojo - the C# library for the Defect Dojo API

To use the API you need be authorized.

This C# SDK is automatically generated by the Swagger Codegen project:

• API version: v2
• SDK version: 1.0.0
• Build package: io.swagger.codegen.languages.CSharpClientCodegen

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.6
• Mono/Xamarin >=vNext
• UWP >=10.0

Dependencies

• FubarCoder.RestSharp.Portable.Core >=4.0.7
• FubarCoder.RestSharp.Portable.HttpClient >=4.0.7
• Newtonsoft.Json >=10.0.3

Installation

Generate the DLL using your preferred tool

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using DefectDojo.Api;
using DefectDojo.Client;
using DefectDojo.Model;

Getting Started

using System;
using System.Diagnostics;
using DefectDojo.Api;
using DefectDojo.Client;
using DefectDojo.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {

            // Configure API key authorization: api_key
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApiTokenAuthApi();
            var data = new AuthToken(); // AuthToken | 

            try
            {
                AuthToken result = apiInstance.ApiTokenAuthCreate(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiTokenAuthApi.ApiTokenAuthCreate: " + e.Message );
            }

        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://localhost:8080/api/v2

Class	Method	HTTP request	Description
ApiTokenAuthApi	ApiTokenAuthCreate	POST /api-token-auth/
DevelopmentEnvironmentsApi	DevelopmentEnvironmentsCreate	POST /development_environments/
DevelopmentEnvironmentsApi	DevelopmentEnvironmentsDelete	DELETE /development_environments/{id}/
DevelopmentEnvironmentsApi	DevelopmentEnvironmentsList	GET /development_environments/
DevelopmentEnvironmentsApi	DevelopmentEnvironmentsPartialUpdate	PATCH /development_environments/{id}/
DevelopmentEnvironmentsApi	DevelopmentEnvironmentsRead	GET /development_environments/{id}/
DevelopmentEnvironmentsApi	DevelopmentEnvironmentsUpdate	PUT /development_environments/{id}/
EndpointStatusApi	EndpointStatusCreate	POST /endpoint_status/
EndpointStatusApi	EndpointStatusDelete	DELETE /endpoint_status/{id}/
EndpointStatusApi	EndpointStatusList	GET /endpoint_status/
EndpointStatusApi	EndpointStatusPartialUpdate	PATCH /endpoint_status/{id}/
EndpointStatusApi	EndpointStatusRead	GET /endpoint_status/{id}/
EndpointStatusApi	EndpointStatusUpdate	PUT /endpoint_status/{id}/
EndpointsApi	EndpointsCreate	POST /endpoints/
EndpointsApi	EndpointsDelete	DELETE /endpoints/{id}/
EndpointsApi	EndpointsGenerateReport	POST /endpoints/{id}/generate_report/
EndpointsApi	EndpointsList	GET /endpoints/
EndpointsApi	EndpointsPartialUpdate	PATCH /endpoints/{id}/
EndpointsApi	EndpointsRead	GET /endpoints/{id}/
EndpointsApi	EndpointsUpdate	PUT /endpoints/{id}/
EngagementsApi	EngagementsAcceptRisks	POST /engagements/{id}/accept_risks/
EngagementsApi	EngagementsClose	POST /engagements/{id}/close/
EngagementsApi	EngagementsCreate	POST /engagements/
EngagementsApi	EngagementsDelete	DELETE /engagements/{id}/
EngagementsApi	EngagementsFilesCreate	POST /engagements/{id}/files/
EngagementsApi	EngagementsFilesPartialUpdate	PATCH /engagements/{id}/files/
EngagementsApi	EngagementsFilesRead	GET /engagements/{id}/files/
EngagementsApi	EngagementsGenerateReport	POST /engagements/{id}/generate_report/
EngagementsApi	EngagementsList	GET /engagements/
EngagementsApi	EngagementsNotesCreate	POST /engagements/{id}/notes/
EngagementsApi	EngagementsNotesPartialUpdate	PATCH /engagements/{id}/notes/
EngagementsApi	EngagementsNotesRead	GET /engagements/{id}/notes/
EngagementsApi	EngagementsPartialUpdate	PATCH /engagements/{id}/
EngagementsApi	EngagementsRead	GET /engagements/{id}/
EngagementsApi	EngagementsReopen	POST /engagements/{id}/reopen/
EngagementsApi	EngagementsUpdate	PUT /engagements/{id}/
FindingTemplatesApi	FindingTemplatesCreate	POST /finding_templates/
FindingTemplatesApi	FindingTemplatesList	GET /finding_templates/
FindingTemplatesApi	FindingTemplatesPartialUpdate	PATCH /finding_templates/{id}/
FindingTemplatesApi	FindingTemplatesRead	GET /finding_templates/{id}/
FindingTemplatesApi	FindingTemplatesUpdate	PUT /finding_templates/{id}/
FindingsApi	FindingsAcceptRisks	POST /findings/accept_risks/
FindingsApi	FindingsCreate	POST /findings/
FindingsApi	FindingsDelete	DELETE /findings/{id}/
FindingsApi	FindingsDuplicateResetFindingDuplicateStatus	POST /findings/{id}/duplicate/reset/
FindingsApi	FindingsFilesCreate	POST /findings/{id}/files/
FindingsApi	FindingsFilesPartialUpdate	PATCH /findings/{id}/files/
FindingsApi	FindingsFilesRead	GET /findings/{id}/files/
FindingsApi	FindingsGenerateReport	POST /findings/generate_report/
FindingsApi	FindingsGetDuplicateStatus	GET /findings/{id}/duplicate/
FindingsApi	FindingsList	GET /findings/
FindingsApi	FindingsMetadataCreate	POST /findings/{id}/metadata/
FindingsApi	FindingsMetadataDelete	DELETE /findings/{id}/metadata/
FindingsApi	FindingsMetadataRead	GET /findings/{id}/metadata/
FindingsApi	FindingsMetadataUpdate	PUT /findings/{id}/metadata/
FindingsApi	FindingsNotesCreate	POST /findings/{id}/notes/
FindingsApi	FindingsNotesPartialUpdate	PATCH /findings/{id}/notes/
FindingsApi	FindingsNotesRead	GET /findings/{id}/notes/
FindingsApi	FindingsPartialUpdate	PATCH /findings/{id}/
FindingsApi	FindingsRead	GET /findings/{id}/
FindingsApi	FindingsRemoveNote	PATCH /findings/{id}/remove_note/
FindingsApi	FindingsRemoveTagsPartialUpdate	PATCH /findings/{id}/remove_tags/
FindingsApi	FindingsRemoveTagsUpdate	PUT /findings/{id}/remove_tags/
FindingsApi	FindingsRequestResponseCreate	POST /findings/{id}/request_response/
FindingsApi	FindingsRequestResponseRead	GET /findings/{id}/request_response/
FindingsApi	FindingsSetFindingAsOriginal	POST /findings/{id}/original/{new_fid}/
FindingsApi	FindingsTagsCreate	POST /findings/{id}/tags/
FindingsApi	FindingsTagsRead	GET /findings/{id}/tags/
FindingsApi	FindingsUpdate	PUT /findings/{id}/
ImportScanApi	ImportScanCreate	POST /import-scan/
JiraConfigurationsApi	JiraConfigurationsCreate	POST /jira_configurations/
JiraConfigurationsApi	JiraConfigurationsDelete	DELETE /jira_configurations/{id}/
JiraConfigurationsApi	JiraConfigurationsList	GET /jira_configurations/
JiraConfigurationsApi	JiraConfigurationsPartialUpdate	PATCH /jira_configurations/{id}/
JiraConfigurationsApi	JiraConfigurationsRead	GET /jira_configurations/{id}/
JiraConfigurationsApi	JiraConfigurationsUpdate	PUT /jira_configurations/{id}/
JiraFindingMappingsApi	JiraFindingMappingsCreate	POST /jira_finding_mappings/
JiraFindingMappingsApi	JiraFindingMappingsDelete	DELETE /jira_finding_mappings/{id}/
JiraFindingMappingsApi	JiraFindingMappingsList	GET /jira_finding_mappings/
JiraFindingMappingsApi	JiraFindingMappingsPartialUpdate	PATCH /jira_finding_mappings/{id}/
JiraFindingMappingsApi	JiraFindingMappingsRead	GET /jira_finding_mappings/{id}/
JiraFindingMappingsApi	JiraFindingMappingsUpdate	PUT /jira_finding_mappings/{id}/
JiraInstancesApi	JiraInstancesCreate	POST /jira_instances/
JiraInstancesApi	JiraInstancesDelete	DELETE /jira_instances/{id}/
JiraInstancesApi	JiraInstancesList	GET /jira_instances/
JiraInstancesApi	JiraInstancesPartialUpdate	PATCH /jira_instances/{id}/
JiraInstancesApi	JiraInstancesRead	GET /jira_instances/{id}/
JiraInstancesApi	JiraInstancesUpdate	PUT /jira_instances/{id}/
JiraProductConfigurationsApi	JiraProductConfigurationsCreate	POST /jira_product_configurations/
JiraProductConfigurationsApi	JiraProductConfigurationsDelete	DELETE /jira_product_configurations/{id}/
JiraProductConfigurationsApi	JiraProductConfigurationsList	GET /jira_product_configurations/
JiraProductConfigurationsApi	JiraProductConfigurationsPartialUpdate	PATCH /jira_product_configurations/{id}/
JiraProductConfigurationsApi	JiraProductConfigurationsRead	GET /jira_product_configurations/{id}/
JiraProductConfigurationsApi	JiraProductConfigurationsUpdate	PUT /jira_product_configurations/{id}/
JiraProjectsApi	JiraProjectsCreate	POST /jira_projects/
JiraProjectsApi	JiraProjectsDelete	DELETE /jira_projects/{id}/
JiraProjectsApi	JiraProjectsList	GET /jira_projects/
JiraProjectsApi	JiraProjectsPartialUpdate	PATCH /jira_projects/{id}/
JiraProjectsApi	JiraProjectsRead	GET /jira_projects/{id}/
JiraProjectsApi	JiraProjectsUpdate	PUT /jira_projects/{id}/
MetadataApi	MetadataCreate	POST /metadata/
MetadataApi	MetadataDelete	DELETE /metadata/{id}/
MetadataApi	MetadataList	GET /metadata/
MetadataApi	MetadataPartialUpdate	PATCH /metadata/{id}/
MetadataApi	MetadataRead	GET /metadata/{id}/
MetadataApi	MetadataUpdate	PUT /metadata/{id}/
NoteTypeApi	NoteTypeCreate	POST /note_type/
NoteTypeApi	NoteTypeDelete	DELETE /note_type/{id}/
NoteTypeApi	NoteTypeList	GET /note_type/
NoteTypeApi	NoteTypePartialUpdate	PATCH /note_type/{id}/
NoteTypeApi	NoteTypeRead	GET /note_type/{id}/
NoteTypeApi	NoteTypeUpdate	PUT /note_type/{id}/
NotesApi	NotesList	GET /notes/
NotesApi	NotesPartialUpdate	PATCH /notes/{id}/
NotesApi	NotesRead	GET /notes/{id}/
NotesApi	NotesUpdate	PUT /notes/{id}/
ProductTypesApi	ProductTypesCreate	POST /product_types/
ProductTypesApi	ProductTypesGenerateReport	POST /product_types/{id}/generate_report/
ProductTypesApi	ProductTypesList	GET /product_types/
ProductTypesApi	ProductTypesPartialUpdate	PATCH /product_types/{id}/
ProductTypesApi	ProductTypesRead	GET /product_types/{id}/
ProductTypesApi	ProductTypesUpdate	PUT /product_types/{id}/
ProductsApi	ProductsCreate	POST /products/
ProductsApi	ProductsDelete	DELETE /products/{id}/
ProductsApi	ProductsGenerateReport	POST /products/{id}/generate_report/
ProductsApi	ProductsList	GET /products/
ProductsApi	ProductsPartialUpdate	PATCH /products/{id}/
ProductsApi	ProductsRead	GET /products/{id}/
ProductsApi	ProductsUpdate	PUT /products/{id}/
RegulationsApi	RegulationsCreate	POST /regulations/
RegulationsApi	RegulationsDelete	DELETE /regulations/{id}/
RegulationsApi	RegulationsList	GET /regulations/
RegulationsApi	RegulationsPartialUpdate	PATCH /regulations/{id}/
RegulationsApi	RegulationsRead	GET /regulations/{id}/
RegulationsApi	RegulationsUpdate	PUT /regulations/{id}/
ReimportScanApi	ReimportScanCreate	POST /reimport-scan/
SonarqubeIssuesApi	SonarqubeIssuesCreate	POST /sonarqube_issues/
SonarqubeIssuesApi	SonarqubeIssuesDelete	DELETE /sonarqube_issues/{id}/
SonarqubeIssuesApi	SonarqubeIssuesList	GET /sonarqube_issues/
SonarqubeIssuesApi	SonarqubeIssuesPartialUpdate	PATCH /sonarqube_issues/{id}/
SonarqubeIssuesApi	SonarqubeIssuesRead	GET /sonarqube_issues/{id}/
SonarqubeIssuesApi	SonarqubeIssuesUpdate	PUT /sonarqube_issues/{id}/
SonarqubeProductConfigurationsApi	SonarqubeProductConfigurationsCreate	POST /sonarqube_product_configurations/
SonarqubeProductConfigurationsApi	SonarqubeProductConfigurationsDelete	DELETE /sonarqube_product_configurations/{id}/
SonarqubeProductConfigurationsApi	SonarqubeProductConfigurationsList	GET /sonarqube_product_configurations/
SonarqubeProductConfigurationsApi	SonarqubeProductConfigurationsPartialUpdate	PATCH /sonarqube_product_configurations/{id}/
SonarqubeProductConfigurationsApi	SonarqubeProductConfigurationsRead	GET /sonarqube_product_configurations/{id}/
SonarqubeProductConfigurationsApi	SonarqubeProductConfigurationsUpdate	PUT /sonarqube_product_configurations/{id}/
SonarqubeTransitionsApi	SonarqubeTransitionsCreate	POST /sonarqube_transitions/
SonarqubeTransitionsApi	SonarqubeTransitionsDelete	DELETE /sonarqube_transitions/{id}/
SonarqubeTransitionsApi	SonarqubeTransitionsList	GET /sonarqube_transitions/
SonarqubeTransitionsApi	SonarqubeTransitionsPartialUpdate	PATCH /sonarqube_transitions/{id}/
SonarqubeTransitionsApi	SonarqubeTransitionsRead	GET /sonarqube_transitions/{id}/
SonarqubeTransitionsApi	SonarqubeTransitionsUpdate	PUT /sonarqube_transitions/{id}/
StubFindingsApi	StubFindingsCreate	POST /stub_findings/
StubFindingsApi	StubFindingsList	GET /stub_findings/
StubFindingsApi	StubFindingsPartialUpdate	PATCH /stub_findings/{id}/
StubFindingsApi	StubFindingsRead	GET /stub_findings/{id}/
StubFindingsApi	StubFindingsUpdate	PUT /stub_findings/{id}/
SystemSettingsApi	SystemSettingsList	GET /system_settings/
SystemSettingsApi	SystemSettingsPartialUpdate	PATCH /system_settings/{id}/
SystemSettingsApi	SystemSettingsUpdate	PUT /system_settings/{id}/
TechnologiesApi	TechnologiesCreate	POST /technologies/
TechnologiesApi	TechnologiesDelete	DELETE /technologies/{id}/
TechnologiesApi	TechnologiesList	GET /technologies/
TechnologiesApi	TechnologiesPartialUpdate	PATCH /technologies/{id}/
TechnologiesApi	TechnologiesRead	GET /technologies/{id}/
TechnologiesApi	TechnologiesUpdate	PUT /technologies/{id}/
TestImportsApi	TestImportsDelete	DELETE /test_imports/{id}/
TestImportsApi	TestImportsList	GET /test_imports/
TestImportsApi	TestImportsRead	GET /test_imports/{id}/
TestTypesApi	TestTypesCreate	POST /test_types/
TestTypesApi	TestTypesList	GET /test_types/
TestTypesApi	TestTypesPartialUpdate	PATCH /test_types/{id}/
TestTypesApi	TestTypesRead	GET /test_types/{id}/
TestTypesApi	TestTypesUpdate	PUT /test_types/{id}/
TestsApi	TestsAcceptRisks	POST /tests/{id}/accept_risks/
TestsApi	TestsCreate	POST /tests/
TestsApi	TestsDelete	DELETE /tests/{id}/
TestsApi	TestsFilesCreate	POST /tests/{id}/files/
TestsApi	TestsFilesPartialUpdate	PATCH /tests/{id}/files/
TestsApi	TestsFilesRead	GET /tests/{id}/files/
TestsApi	TestsGenerateReport	POST /tests/{id}/generate_report/
TestsApi	TestsList	GET /tests/
TestsApi	TestsNotesCreate	POST /tests/{id}/notes/
TestsApi	TestsNotesPartialUpdate	PATCH /tests/{id}/notes/
TestsApi	TestsNotesRead	GET /tests/{id}/notes/
TestsApi	TestsPartialUpdate	PATCH /tests/{id}/
TestsApi	TestsRead	GET /tests/{id}/
TestsApi	TestsUpdate	PUT /tests/{id}/
ToolConfigurationsApi	ToolConfigurationsCreate	POST /tool_configurations/
ToolConfigurationsApi	ToolConfigurationsDelete	DELETE /tool_configurations/{id}/
ToolConfigurationsApi	ToolConfigurationsList	GET /tool_configurations/
ToolConfigurationsApi	ToolConfigurationsPartialUpdate	PATCH /tool_configurations/{id}/
ToolConfigurationsApi	ToolConfigurationsRead	GET /tool_configurations/{id}/
ToolConfigurationsApi	ToolConfigurationsUpdate	PUT /tool_configurations/{id}/
ToolProductSettingsApi	ToolProductSettingsCreate	POST /tool_product_settings/
ToolProductSettingsApi	ToolProductSettingsDelete	DELETE /tool_product_settings/{id}/
ToolProductSettingsApi	ToolProductSettingsList	GET /tool_product_settings/
ToolProductSettingsApi	ToolProductSettingsPartialUpdate	PATCH /tool_product_settings/{id}/
ToolProductSettingsApi	ToolProductSettingsRead	GET /tool_product_settings/{id}/
ToolProductSettingsApi	ToolProductSettingsUpdate	PUT /tool_product_settings/{id}/
ToolTypesApi	ToolTypesCreate	POST /tool_types/
ToolTypesApi	ToolTypesDelete	DELETE /tool_types/{id}/
ToolTypesApi	ToolTypesList	GET /tool_types/
ToolTypesApi	ToolTypesPartialUpdate	PATCH /tool_types/{id}/
ToolTypesApi	ToolTypesRead	GET /tool_types/{id}/
ToolTypesApi	ToolTypesUpdate	PUT /tool_types/{id}/
UsersApi	UsersCreate	POST /users/
UsersApi	UsersList	GET /users/
UsersApi	UsersPartialUpdate	PATCH /users/{id}/
UsersApi	UsersRead	GET /users/{id}/
UsersApi	UsersUpdate	PUT /users/{id}/

Documentation for Models

• Model.AcceptedRisk
• Model.AddNewFileOption
• Model.AddNewNoteOption
• Model.AppAnalysis
• Model.AuthToken
• Model.BurpRawRequestResponse
• Model.DevelopmentEnvironment
• Model.Endpoint
• Model.EndpointStatus
• Model.Engagement
• Model.EngagementToFiles
• Model.ExecutiveSummary
• Model.Finding
• Model.FindingCreate
• Model.FindingEngagement
• Model.FindingEnvironment
• Model.FindingGroup
• Model.FindingImage
• Model.FindingMeta
• Model.FindingNote
• Model.FindingProdType
• Model.FindingProduct
• Model.FindingRelatedFields
• Model.FindingTemplate
• Model.FindingTest
• Model.FindingTestType
• Model.FindingToFiles
• Model.FindingToFindingImages
• Model.FindingToNotes
• Model.ImportScan
• Model.InlineResponse200
• Model.InlineResponse2001
• Model.InlineResponse20010
• Model.InlineResponse20011
• Model.InlineResponse20012
• Model.InlineResponse20013
• Model.InlineResponse20013Prefetch
• Model.InlineResponse20014
• Model.InlineResponse20015
• Model.InlineResponse20015Prefetch
• Model.InlineResponse20016
• Model.InlineResponse20017
• Model.InlineResponse20018
• Model.InlineResponse20019
• Model.InlineResponse2002
• Model.InlineResponse20020
• Model.InlineResponse20021
• Model.InlineResponse20022
• Model.InlineResponse20023
• Model.InlineResponse20024
• Model.InlineResponse20024Prefetch
• Model.InlineResponse20025
• Model.InlineResponse20026
• Model.InlineResponse20027
• Model.InlineResponse20028
• Model.InlineResponse20029
• Model.InlineResponse2003
• Model.InlineResponse20030
• Model.InlineResponse20031
• Model.InlineResponse2004
• Model.InlineResponse2005
• Model.InlineResponse2005Prefetch
• Model.InlineResponse2006
• Model.InlineResponse2007
• Model.InlineResponse2008
• Model.InlineResponse2009
• Model.JIRAInstance
• Model.JIRAIssue
• Model.JIRAProject
• Model.Meta
• Model.Note
• Model.NoteHistory
• Model.NoteType
• Model.Product
• Model.ProductMeta
• Model.ProductType
• Model.File
• Model.ReImportScan
• Model.Regulation
• Model.ReportGenerate
• Model.ReportGenerateOption
• Model.RiskAcceptance
• Model.SonarqubeIssue
• Model.SonarqubeIssueTransition
• Model.SonarqubeProduct
• Model.StubFinding
• Model.StubFindingCreate
• Model.SystemSettings
• Model.Tag
• Model.Test
• Model.TestCreate
• Model.TestImport
• Model.TestImportFindingAction
• Model.TestToFiles
• Model.TestType
• Model.ToolConfiguration
• Model.ToolProductSettings
• Model.ToolType
• Model.User
• Model.UserStub

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header