defectdojo_api_generated.EngagementsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
accept_risks_create	POST /api/v2/engagements/{id}/accept_risks/
close_create	POST /api/v2/engagements/{id}/close/
complete_checklist_create	POST /api/v2/engagements/{id}/complete_checklist/
complete_checklist_retrieve	GET /api/v2/engagements/{id}/complete_checklist/
create	POST /api/v2/engagements/
delete_preview_list	GET /api/v2/engagements/{id}/delete_preview/
destroy	DELETE /api/v2/engagements/{id}/
files_create	POST /api/v2/engagements/{id}/files/
files_download_retrieve	GET /api/v2/engagements/{id}/files/download/{file_id}/
files_retrieve	GET /api/v2/engagements/{id}/files/
generate_report_create	POST /api/v2/engagements/{id}/generate_report/
list	GET /api/v2/engagements/
notes_create	POST /api/v2/engagements/{id}/notes/
notes_retrieve	GET /api/v2/engagements/{id}/notes/
partial_update	PATCH /api/v2/engagements/{id}/
reopen_create	POST /api/v2/engagements/{id}/reopen/
retrieve	GET /api/v2/engagements/{id}/
update	PUT /api/v2/engagements/{id}/
update_jira_epic_create	POST /api/v2/engagements/{id}/update_jira_epic/

accept_risks_create

List[RiskAcceptance] accept_risks_create(id, accepted_risk_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.accepted_risk_request import AcceptedRiskRequest
from defectdojo_api_generated.models.risk_acceptance import RiskAcceptance
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    accepted_risk_request = [defectdojo_api_generated.AcceptedRiskRequest()] # List[AcceptedRiskRequest] | 

    try:
        api_response = api_instance.accept_risks_create(id, accepted_risk_request)
        print("The response of EngagementsApi->accept_risks_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->accept_risks_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
accepted_risk_request	List[AcceptedRiskRequest]

Return type

List[RiskAcceptance]

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

close_create

close_create(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_instance.close_create(id)
    except Exception as e:
        print("Exception when calling EngagementsApi->close_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

void (empty response body)

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

complete_checklist_create

EngagementCheckList complete_checklist_create(id, engagement_check_list_request=engagement_check_list_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement_check_list import EngagementCheckList
from defectdojo_api_generated.models.engagement_check_list_request import EngagementCheckListRequest
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    engagement_check_list_request = defectdojo_api_generated.EngagementCheckListRequest() # EngagementCheckListRequest |  (optional)

    try:
        api_response = api_instance.complete_checklist_create(id, engagement_check_list_request=engagement_check_list_request)
        print("The response of EngagementsApi->complete_checklist_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->complete_checklist_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
engagement_check_list_request	EngagementCheckListRequest		[optional]

Return type

EngagementCheckList

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

complete_checklist_retrieve

Engagement complete_checklist_retrieve(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement import Engagement
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_response = api_instance.complete_checklist_retrieve(id)
        print("The response of EngagementsApi->complete_checklist_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->complete_checklist_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

Engagement

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create

Engagement create(engagement_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement import Engagement
from defectdojo_api_generated.models.engagement_request import EngagementRequest
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    engagement_request = defectdojo_api_generated.EngagementRequest() # EngagementRequest | 

    try:
        api_response = api_instance.create(engagement_request)
        print("The response of EngagementsApi->create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->create: %s\n" % e)

Parameters

Name	Type	Description	Notes
engagement_request	EngagementRequest

Return type

Engagement

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_preview_list

PaginatedDeletePreviewList delete_preview_list(id, limit=limit, offset=offset)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.paginated_delete_preview_list import PaginatedDeletePreviewList
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    limit = 56 # int | Number of results to return per page. (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)

    try:
        api_response = api_instance.delete_preview_list(id, limit=limit, offset=offset)
        print("The response of EngagementsApi->delete_preview_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->delete_preview_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]

Return type

PaginatedDeletePreviewList

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

destroy

destroy(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_instance.destroy(id)
    except Exception as e:
        print("Exception when calling EngagementsApi->destroy: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

void (empty response body)

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_create

File files_create(id, title=title, file=file)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.file import File
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    title = 'title_example' # str |  (optional)
    file = None # bytearray |  (optional)

    try:
        api_response = api_instance.files_create(id, title=title, file=file)
        print("The response of EngagementsApi->files_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->files_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
title	str		[optional]
file	bytearray		[optional]

Return type

File

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_download_retrieve

RawFile files_download_retrieve(file_id, id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.raw_file import RawFile
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    file_id = 'file_id_example' # str | 
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_response = api_instance.files_download_retrieve(file_id, id)
        print("The response of EngagementsApi->files_download_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->files_download_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
file_id	str
id	int	A unique integer value identifying this engagement.

Return type

RawFile

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

files_retrieve

EngagementToFiles files_retrieve(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement_to_files import EngagementToFiles
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_response = api_instance.files_retrieve(id)
        print("The response of EngagementsApi->files_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->files_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

EngagementToFiles

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

generate_report_create

ReportGenerate generate_report_create(id, report_generate_option_request=report_generate_option_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.report_generate import ReportGenerate
from defectdojo_api_generated.models.report_generate_option_request import ReportGenerateOptionRequest
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    report_generate_option_request = defectdojo_api_generated.ReportGenerateOptionRequest() # ReportGenerateOptionRequest |  (optional)

    try:
        api_response = api_instance.generate_report_create(id, report_generate_option_request=report_generate_option_request)
        print("The response of EngagementsApi->generate_report_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->generate_report_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
report_generate_option_request	ReportGenerateOptionRequest		[optional]

Return type

ReportGenerate

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

PaginatedEngagementList list(active=active, api_test=api_test, has_tags=has_tags, id=id, limit=limit, name=name, not_product__tags=not_product__tags, not_tag=not_tag, not_tags=not_tags, o=o, offset=offset, pen_test=pen_test, product=product, product__prod_type=product__prod_type, product__tags=product__tags, product__tags__and=product__tags__and, report_type=report_type, requester=requester, status=status, tag=tag, tags=tags, tags__and=tags__and, target_end=target_end, target_start=target_start, threat_model=threat_model, updated=updated, version=version)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.paginated_engagement_list import PaginatedEngagementList
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    active = True # bool |  (optional)
    api_test = True # bool |  (optional)
    has_tags = True # bool | Has tags (optional)
    id = 56 # int |  (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str |  (optional)
    not_product__tags = ['not_product__tags_example'] # List[str] | Comma separated list of exact tags not present on Product (optional)
    not_tag = 'not_tag_example' # str | Not Tag name contains (optional)
    not_tags = ['not_tags_example'] # List[str] | Comma separated list of exact tags not present on model (optional)
    o = ['o_example'] # List[str] | Ordering  * `name` - Engagement Name * `-name` - Engagement Name (descending) * `version` - Version * `-version` - Version (descending) * `target_start` - Target start * `-target_start` - Target start (descending) * `target_end` - Target end * `-target_end` - Target end (descending) * `status` - Status * `-status` - Status (descending) * `lead` - Lead * `-lead` - Lead (descending) * `created` - Created * `-created` - Created (descending) * `updated` - Updated * `-updated` - Updated (descending) (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    pen_test = True # bool |  (optional)
    product = 56 # int |  (optional)
    product__prod_type = [56] # List[int] | Multiple values may be separated by commas. (optional)
    product__tags = ['product__tags_example'] # List[str] | Comma separated list of exact tags present on Product (uses OR for multiple values) (optional)
    product__tags__and = ['product__tags__and_example'] # List[str] | Comma separated list of exact tags to match with an AND expression present on Product (optional)
    report_type = 56 # int |  (optional)
    requester = 56 # int |  (optional)
    status = 'status_example' # str | * `Not Started` - Not Started * `Blocked` - Blocked * `Cancelled` - Cancelled * `Completed` - Completed * `In Progress` - In Progress * `On Hold` - On Hold * `Scheduled` - Scheduled * `Waiting for Resource` - Waiting for Resource (optional)
    tag = 'tag_example' # str | Tag name contains (optional)
    tags = ['tags_example'] # List[str] | Comma separated list of exact tags (uses OR for multiple values) (optional)
    tags__and = ['tags__and_example'] # List[str] | Comma separated list of exact tags to match with an AND expression (optional)
    target_end = '2013-10-20' # date |  (optional)
    target_start = '2013-10-20' # date |  (optional)
    threat_model = True # bool |  (optional)
    updated = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    version = 'version_example' # str |  (optional)

    try:
        api_response = api_instance.list(active=active, api_test=api_test, has_tags=has_tags, id=id, limit=limit, name=name, not_product__tags=not_product__tags, not_tag=not_tag, not_tags=not_tags, o=o, offset=offset, pen_test=pen_test, product=product, product__prod_type=product__prod_type, product__tags=product__tags, product__tags__and=product__tags__and, report_type=report_type, requester=requester, status=status, tag=tag, tags=tags, tags__and=tags__and, target_end=target_end, target_start=target_start, threat_model=threat_model, updated=updated, version=version)
        print("The response of EngagementsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
active	bool		[optional]
api_test	bool		[optional]
has_tags	bool	Has tags	[optional]
id	int		[optional]
limit	int	Number of results to return per page.	[optional]
name	str		[optional]
not_product__tags	List[str]	Comma separated list of exact tags not present on Product	[optional]
not_tag	str	Not Tag name contains	[optional]
not_tags	List[str]	Comma separated list of exact tags not present on model	[optional]
o	List[str]	Ordering * `name` - Engagement Name * `-name` - Engagement Name (descending) * `version` - Version * `-version` - Version (descending) * `target_start` - Target start * `-target_start` - Target start (descending) * `target_end` - Target end * `-target_end` - Target end (descending) * `status` - Status * `-status` - Status (descending) * `lead` - Lead * `-lead` - Lead (descending) * `created` - Created * `-created` - Created (descending) * `updated` - Updated * `-updated` - Updated (descending)	[optional]
offset	int	The initial index from which to return the results.	[optional]
pen_test	bool		[optional]
product	int		[optional]
product__prod_type	List[int]	Multiple values may be separated by commas.	[optional]
product__tags	List[str]	Comma separated list of exact tags present on Product (uses OR for multiple values)	[optional]
product__tags__and	List[str]	Comma separated list of exact tags to match with an AND expression present on Product	[optional]
report_type	int		[optional]
requester	int		[optional]
status	str	* `Not Started` - Not Started * `Blocked` - Blocked * `Cancelled` - Cancelled * `Completed` - Completed * `In Progress` - In Progress * `On Hold` - On Hold * `Scheduled` - Scheduled * `Waiting for Resource` - Waiting for Resource	[optional]
tag	str	Tag name contains	[optional]
tags	List[str]	Comma separated list of exact tags (uses OR for multiple values)	[optional]
tags__and	List[str]	Comma separated list of exact tags to match with an AND expression	[optional]
target_end	date		[optional]
target_start	date		[optional]
threat_model	bool		[optional]
updated	datetime		[optional]
version	str		[optional]

Return type

PaginatedEngagementList

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notes_create

Note notes_create(id, add_new_note_option_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.add_new_note_option_request import AddNewNoteOptionRequest
from defectdojo_api_generated.models.note import Note
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    add_new_note_option_request = defectdojo_api_generated.AddNewNoteOptionRequest() # AddNewNoteOptionRequest | 

    try:
        api_response = api_instance.notes_create(id, add_new_note_option_request)
        print("The response of EngagementsApi->notes_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->notes_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
add_new_note_option_request	AddNewNoteOptionRequest

Return type

Note

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notes_retrieve

EngagementToNotes notes_retrieve(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement_to_notes import EngagementToNotes
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_response = api_instance.notes_retrieve(id)
        print("The response of EngagementsApi->notes_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->notes_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

EngagementToNotes

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

partial_update

Engagement partial_update(id, patched_engagement_request=patched_engagement_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement import Engagement
from defectdojo_api_generated.models.patched_engagement_request import PatchedEngagementRequest
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    patched_engagement_request = defectdojo_api_generated.PatchedEngagementRequest() # PatchedEngagementRequest |  (optional)

    try:
        api_response = api_instance.partial_update(id, patched_engagement_request=patched_engagement_request)
        print("The response of EngagementsApi->partial_update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->partial_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
patched_engagement_request	PatchedEngagementRequest		[optional]

Return type

Engagement

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reopen_create

reopen_create(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_instance.reopen_create(id)
    except Exception as e:
        print("Exception when calling EngagementsApi->reopen_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

void (empty response body)

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	No response body	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrieve

Engagement retrieve(id)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement import Engagement
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.

    try:
        api_response = api_instance.retrieve(id)
        print("The response of EngagementsApi->retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.

Return type

Engagement

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

Engagement update(id, engagement_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement import Engagement
from defectdojo_api_generated.models.engagement_request import EngagementRequest
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    engagement_request = defectdojo_api_generated.EngagementRequest() # EngagementRequest | 

    try:
        api_response = api_instance.update(id, engagement_request)
        print("The response of EngagementsApi->update:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->update: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
engagement_request	EngagementRequest

Return type

Engagement

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_jira_epic_create

EngagementUpdateJiraEpic update_jira_epic_create(id, engagement_update_jira_epic_request=engagement_update_jira_epic_request)

Example

• Basic Authentication (basicAuth):
• Api Key Authentication (cookieAuth):
• Api Key Authentication (tokenAuth):

import defectdojo_api_generated
from defectdojo_api_generated.models.engagement_update_jira_epic import EngagementUpdateJiraEpic
from defectdojo_api_generated.models.engagement_update_jira_epic_request import EngagementUpdateJiraEpicRequest
from defectdojo_api_generated.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = defectdojo_api_generated.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = defectdojo_api_generated.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure API key authorization: cookieAuth
configuration.api_key['cookieAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookieAuth'] = 'Bearer'

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with defectdojo_api_generated.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = defectdojo_api_generated.EngagementsApi(api_client)
    id = 56 # int | A unique integer value identifying this engagement.
    engagement_update_jira_epic_request = defectdojo_api_generated.EngagementUpdateJiraEpicRequest() # EngagementUpdateJiraEpicRequest |  (optional)

    try:
        api_response = api_instance.update_jira_epic_create(id, engagement_update_jira_epic_request=engagement_update_jira_epic_request)
        print("The response of EngagementsApi->update_jira_epic_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling EngagementsApi->update_jira_epic_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this engagement.
engagement_update_jira_epic_request	EngagementUpdateJiraEpicRequest		[optional]

Return type

EngagementUpdateJiraEpic

Authorization

basicAuth, cookieAuth, tokenAuth

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200		-

[Back to top] [Back to API list] [Back to Model list] [Back to README]