defectdojo-api-v2-client

To use the API you need be authorized.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v2
• Package version: 0.0.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client 

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

configuration = openapi_client.Configuration()
# Configure API key authorization: api_key
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Authorization'] = 'Bearer'

# Defining host is optional and default to http://localhost:8080/api/v2
configuration.host = "http://localhost:8080/api/v2"
# Create an instance of the API class
api_instance = openapi_client.ApiTokenAuthApi(openapi_client.ApiClient(configuration))

try:
    api_instance.api_token_auth_create()
except ApiException as e:
    print("Exception when calling ApiTokenAuthApi->api_token_auth_create: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ApiTokenAuthApi	api_token_auth_create	POST /api-token-auth/
DevelopmentEnvironmentsApi	development_environments_create	POST /development_environments/
DevelopmentEnvironmentsApi	development_environments_list	GET /development_environments/
DevelopmentEnvironmentsApi	development_environments_partial_update	PATCH /development_environments/{id}/
DevelopmentEnvironmentsApi	development_environments_read	GET /development_environments/{id}/
DevelopmentEnvironmentsApi	development_environments_update	PUT /development_environments/{id}/
EndpointsApi	endpoints_create	POST /endpoints/
EndpointsApi	endpoints_delete	DELETE /endpoints/{id}/
EndpointsApi	endpoints_generate_report	POST /endpoints/{id}/generate_report/
EndpointsApi	endpoints_list	GET /endpoints/
EndpointsApi	endpoints_partial_update	PATCH /endpoints/{id}/
EndpointsApi	endpoints_read	GET /endpoints/{id}/
EndpointsApi	endpoints_update	PUT /endpoints/{id}/
EngagementsApi	engagements_close	POST /engagements/{id}/close/
EngagementsApi	engagements_create	POST /engagements/
EngagementsApi	engagements_delete	DELETE /engagements/{id}/
EngagementsApi	engagements_generate_report	POST /engagements/{id}/generate_report/
EngagementsApi	engagements_list	GET /engagements/
EngagementsApi	engagements_partial_update	PATCH /engagements/{id}/
EngagementsApi	engagements_read	GET /engagements/{id}/
EngagementsApi	engagements_reopen	POST /engagements/{id}/reopen/
EngagementsApi	engagements_update	PUT /engagements/{id}/
FindingTemplatesApi	finding_templates_create	POST /finding_templates/
FindingTemplatesApi	finding_templates_list	GET /finding_templates/
FindingTemplatesApi	finding_templates_partial_update	PATCH /finding_templates/{id}/
FindingTemplatesApi	finding_templates_read	GET /finding_templates/{id}/
FindingTemplatesApi	finding_templates_update	PUT /finding_templates/{id}/
FindingsApi	findings_create	POST /findings/
FindingsApi	findings_delete	DELETE /findings/{id}/
FindingsApi	findings_generate_report	POST /findings/generate_report/
FindingsApi	findings_list	GET /findings/
FindingsApi	findings_notes_create	POST /findings/{id}/notes/
FindingsApi	findings_notes_read	GET /findings/{id}/notes/
FindingsApi	findings_partial_update	PATCH /findings/{id}/
FindingsApi	findings_read	GET /findings/{id}/
FindingsApi	findings_remove_note_partial_update	PATCH /findings/{id}/remove_note/
FindingsApi	findings_remove_note_update	PUT /findings/{id}/remove_note/
FindingsApi	findings_remove_tags_partial_update	PATCH /findings/{id}/remove_tags/
FindingsApi	findings_remove_tags_update	PUT /findings/{id}/remove_tags/
FindingsApi	findings_tags_create	POST /findings/{id}/tags/
FindingsApi	findings_tags_read	GET /findings/{id}/tags/
FindingsApi	findings_update	PUT /findings/{id}/
ImportScanApi	import_scan_create	POST /import-scan/
JiraConfigurationsApi	jira_configurations_create	POST /jira_configurations/
JiraConfigurationsApi	jira_configurations_delete	DELETE /jira_configurations/{id}/
JiraConfigurationsApi	jira_configurations_list	GET /jira_configurations/
JiraConfigurationsApi	jira_configurations_partial_update	PATCH /jira_configurations/{id}/
JiraConfigurationsApi	jira_configurations_read	GET /jira_configurations/{id}/
JiraConfigurationsApi	jira_configurations_update	PUT /jira_configurations/{id}/
JiraFindingMappingsApi	jira_finding_mappings_create	POST /jira_finding_mappings/
JiraFindingMappingsApi	jira_finding_mappings_delete	DELETE /jira_finding_mappings/{id}/
JiraFindingMappingsApi	jira_finding_mappings_list	GET /jira_finding_mappings/
JiraFindingMappingsApi	jira_finding_mappings_partial_update	PATCH /jira_finding_mappings/{id}/
JiraFindingMappingsApi	jira_finding_mappings_read	GET /jira_finding_mappings/{id}/
JiraFindingMappingsApi	jira_finding_mappings_update	PUT /jira_finding_mappings/{id}/
JiraProductConfigurationsApi	jira_product_configurations_create	POST /jira_product_configurations/
JiraProductConfigurationsApi	jira_product_configurations_delete	DELETE /jira_product_configurations/{id}/
JiraProductConfigurationsApi	jira_product_configurations_list	GET /jira_product_configurations/
JiraProductConfigurationsApi	jira_product_configurations_partial_update	PATCH /jira_product_configurations/{id}/
JiraProductConfigurationsApi	jira_product_configurations_read	GET /jira_product_configurations/{id}/
JiraProductConfigurationsApi	jira_product_configurations_update	PUT /jira_product_configurations/{id}/
MetadataApi	metadata_create	POST /metadata/
MetadataApi	metadata_delete	DELETE /metadata/{id}/
MetadataApi	metadata_list	GET /metadata/
MetadataApi	metadata_partial_update	PATCH /metadata/{id}/
MetadataApi	metadata_read	GET /metadata/{id}/
MetadataApi	metadata_update	PUT /metadata/{id}/
NotesApi	notes_list	GET /notes/
NotesApi	notes_partial_update	PATCH /notes/{id}/
NotesApi	notes_read	GET /notes/{id}/
NotesApi	notes_update	PUT /notes/{id}/
ProductTypesApi	product_types_create	POST /product_types/
ProductTypesApi	product_types_generate_report	POST /product_types/{id}/generate_report/
ProductTypesApi	product_types_list	GET /product_types/
ProductTypesApi	product_types_partial_update	PATCH /product_types/{id}/
ProductTypesApi	product_types_read	GET /product_types/{id}/
ProductTypesApi	product_types_update	PUT /product_types/{id}/
ProductsApi	products_create	POST /products/
ProductsApi	products_generate_report	POST /products/{id}/generate_report/
ProductsApi	products_list	GET /products/
ProductsApi	products_partial_update	PATCH /products/{id}/
ProductsApi	products_read	GET /products/{id}/
ProductsApi	products_update	PUT /products/{id}/
ReimportScanApi	reimport_scan_create	POST /reimport-scan/
ScanSettingsApi	scan_settings_create	POST /scan_settings/
ScanSettingsApi	scan_settings_delete	DELETE /scan_settings/{id}/
ScanSettingsApi	scan_settings_list	GET /scan_settings/
ScanSettingsApi	scan_settings_partial_update	PATCH /scan_settings/{id}/
ScanSettingsApi	scan_settings_read	GET /scan_settings/{id}/
ScanSettingsApi	scan_settings_update	PUT /scan_settings/{id}/
ScansApi	scans_list	GET /scans/
ScansApi	scans_read	GET /scans/{id}/
StubFindingsApi	stub_findings_create	POST /stub_findings/
StubFindingsApi	stub_findings_list	GET /stub_findings/
StubFindingsApi	stub_findings_partial_update	PATCH /stub_findings/{id}/
StubFindingsApi	stub_findings_read	GET /stub_findings/{id}/
StubFindingsApi	stub_findings_update	PUT /stub_findings/{id}/
TestTypesApi	test_types_create	POST /test_types/
TestTypesApi	test_types_list	GET /test_types/
TestTypesApi	test_types_partial_update	PATCH /test_types/{id}/
TestTypesApi	test_types_read	GET /test_types/{id}/
TestTypesApi	test_types_update	PUT /test_types/{id}/
TestsApi	tests_create	POST /tests/
TestsApi	tests_delete	DELETE /tests/{id}/
TestsApi	tests_generate_report	POST /tests/{id}/generate_report/
TestsApi	tests_list	GET /tests/
TestsApi	tests_partial_update	PATCH /tests/{id}/
TestsApi	tests_read	GET /tests/{id}/
TestsApi	tests_update	PUT /tests/{id}/
ToolConfigurationsApi	tool_configurations_create	POST /tool_configurations/
ToolConfigurationsApi	tool_configurations_delete	DELETE /tool_configurations/{id}/
ToolConfigurationsApi	tool_configurations_list	GET /tool_configurations/
ToolConfigurationsApi	tool_configurations_partial_update	PATCH /tool_configurations/{id}/
ToolConfigurationsApi	tool_configurations_read	GET /tool_configurations/{id}/
ToolConfigurationsApi	tool_configurations_update	PUT /tool_configurations/{id}/
ToolProductSettingsApi	tool_product_settings_create	POST /tool_product_settings/
ToolProductSettingsApi	tool_product_settings_delete	DELETE /tool_product_settings/{id}/
ToolProductSettingsApi	tool_product_settings_list	GET /tool_product_settings/
ToolProductSettingsApi	tool_product_settings_partial_update	PATCH /tool_product_settings/{id}/
ToolProductSettingsApi	tool_product_settings_read	GET /tool_product_settings/{id}/
ToolProductSettingsApi	tool_product_settings_update	PUT /tool_product_settings/{id}/
ToolTypesApi	tool_types_create	POST /tool_types/
ToolTypesApi	tool_types_delete	DELETE /tool_types/{id}/
ToolTypesApi	tool_types_list	GET /tool_types/
ToolTypesApi	tool_types_partial_update	PATCH /tool_types/{id}/
ToolTypesApi	tool_types_read	GET /tool_types/{id}/
ToolTypesApi	tool_types_update	PUT /tool_types/{id}/
UsersApi	users_list	GET /users/
UsersApi	users_read	GET /users/{id}/

Documentation For Models

• DevelopmentEnvironment
• Endpoint
• Engagement
• Finding
• FindingCreate
• FindingImage
• FindingTemplate
• ImportScan
• InlineResponse200
• InlineResponse2001
• InlineResponse20010
• InlineResponse20011
• InlineResponse20012
• InlineResponse20013
• InlineResponse20014
• InlineResponse20015
• InlineResponse20016
• InlineResponse20017
• InlineResponse20018
• InlineResponse20019
• InlineResponse2002
• InlineResponse20020
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• InlineResponse2007
• InlineResponse2008
• InlineResponse2009
• JIRA
• JIRAConf
• JIRAIssue
• Meta
• Note
• NoteHistory
• Product
• ProductMeta
• ProductType
• ReImportScan
• Scan
• ScanSettings
• ScanSettingsCreate
• StubFinding
• StubFindingCreate
• Test
• TestCreate
• TestType
• ToolConfiguration
• ToolProductSettings
• ToolType
• User

Documentation For Authorization

api_key

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

Development

This code was generated with openapi-generator in version 4.1.2. To update the code start defectdojo and run:

java -jar openapi-generator-cli.jar generate -i http://localhost:8080/api/v2/doc/?format=openapi --minimal-update -g python -c defectdojo-api-v2-client/openapi-generator-python-config.yaml -o defectdojo-api-v2-client/