defectdojo_api_generated.RiskAcceptanceApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create	POST /api/v2/risk_acceptance/
delete_preview_list	GET /api/v2/risk_acceptance/{id}/delete_preview/
destroy	DELETE /api/v2/risk_acceptance/{id}/
download_proof_retrieve	GET /api/v2/risk_acceptance/{id}/download_proof/
list	GET /api/v2/risk_acceptance/
notes_create	POST /api/v2/risk_acceptance/{id}/notes/
notes_retrieve	GET /api/v2/risk_acceptance/{id}/notes/
partial_update	PATCH /api/v2/risk_acceptance/{id}/
retrieve	GET /api/v2/risk_acceptance/{id}/
update	PUT /api/v2/risk_acceptance/{id}/

create

RiskAcceptance create(risk_acceptance_request)

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.risk_acceptance import RiskAcceptance
from defectdojo_api_generated.models.risk_acceptance_request import RiskAcceptanceRequest
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.RiskAcceptanceApi(api_client)
    risk_acceptance_request = defectdojo_api_generated.RiskAcceptanceRequest() # RiskAcceptanceRequest | 

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

Parameters

Name	Type	Description	Notes
risk_acceptance_request	RiskAcceptanceRequest

Return type

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]

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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.
    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 RiskAcceptanceApi->delete_preview_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RiskAcceptanceApi->delete_preview_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this risk_ acceptance.
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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.

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

Parameters

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

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]

download_proof_retrieve

RiskAcceptanceProof download_proof_retrieve(id)

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.risk_acceptance_proof import RiskAcceptanceProof
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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.

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

Parameters

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

Return type

RiskAcceptanceProof

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]

list

PaginatedRiskAcceptanceList list(accepted_by=accepted_by, accepted_findings=accepted_findings, decision=decision, decision_details=decision_details, expiration_date=expiration_date, expiration_date_handled=expiration_date_handled, expiration_date_warned=expiration_date_warned, limit=limit, name=name, notes=notes, o=o, offset=offset, owner=owner, reactivate_expired=reactivate_expired, recommendation=recommendation, recommendation_details=recommendation_details, restart_sla_expired=restart_sla_expired)

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.paginated_risk_acceptance_list import PaginatedRiskAcceptanceList
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.RiskAcceptanceApi(api_client)
    accepted_by = 'accepted_by_example' # str |  (optional)
    accepted_findings = [56] # List[int] |  (optional)
    decision = 'decision_example' # str | Risk treatment decision by risk owner  * `A` - Accept (The risk is acknowledged, yet remains) * `V` - Avoid (Do not engage with whatever creates the risk) * `M` - Mitigate (The risk still exists, yet compensating controls make it less of a threat) * `F` - Fix (The risk is eradicated) * `T` - Transfer (The risk is transferred to a 3rd party) (optional)
    decision_details = 'decision_details_example' # str |  (optional)
    expiration_date = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    expiration_date_handled = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    expiration_date_warned = '2013-10-20T19:20:30+01:00' # datetime |  (optional)
    limit = 56 # int | Number of results to return per page. (optional)
    name = 'name_example' # str |  (optional)
    notes = [56] # List[int] |  (optional)
    o = ['o_example'] # List[str] | Ordering  * `name` - Name * `-name` - Name (descending) (optional)
    offset = 56 # int | The initial index from which to return the results. (optional)
    owner = 56 # int |  (optional)
    reactivate_expired = True # bool |  (optional)
    recommendation = 'recommendation_example' # str | Recommendation from the security team.  * `A` - Accept (The risk is acknowledged, yet remains) * `V` - Avoid (Do not engage with whatever creates the risk) * `M` - Mitigate (The risk still exists, yet compensating controls make it less of a threat) * `F` - Fix (The risk is eradicated) * `T` - Transfer (The risk is transferred to a 3rd party) (optional)
    recommendation_details = 'recommendation_details_example' # str |  (optional)
    restart_sla_expired = True # bool |  (optional)

    try:
        api_response = api_instance.list(accepted_by=accepted_by, accepted_findings=accepted_findings, decision=decision, decision_details=decision_details, expiration_date=expiration_date, expiration_date_handled=expiration_date_handled, expiration_date_warned=expiration_date_warned, limit=limit, name=name, notes=notes, o=o, offset=offset, owner=owner, reactivate_expired=reactivate_expired, recommendation=recommendation, recommendation_details=recommendation_details, restart_sla_expired=restart_sla_expired)
        print("The response of RiskAcceptanceApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RiskAcceptanceApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
accepted_by	str		[optional]
accepted_findings	List[int]		[optional]
decision	str	Risk treatment decision by risk owner * `A` - Accept (The risk is acknowledged, yet remains) * `V` - Avoid (Do not engage with whatever creates the risk) * `M` - Mitigate (The risk still exists, yet compensating controls make it less of a threat) * `F` - Fix (The risk is eradicated) * `T` - Transfer (The risk is transferred to a 3rd party)	[optional]
decision_details	str		[optional]
expiration_date	datetime		[optional]
expiration_date_handled	datetime		[optional]
expiration_date_warned	datetime		[optional]
limit	int	Number of results to return per page.	[optional]
name	str		[optional]
notes	List[int]		[optional]
o	List[str]	Ordering * `name` - Name * `-name` - Name (descending)	[optional]
offset	int	The initial index from which to return the results.	[optional]
owner	int		[optional]
reactivate_expired	bool		[optional]
recommendation	str	Recommendation from the security team. * `A` - Accept (The risk is acknowledged, yet remains) * `V` - Avoid (Do not engage with whatever creates the risk) * `M` - Mitigate (The risk still exists, yet compensating controls make it less of a threat) * `F` - Fix (The risk is eradicated) * `T` - Transfer (The risk is transferred to a 3rd party)	[optional]
recommendation_details	str		[optional]
restart_sla_expired	bool		[optional]

Return type

PaginatedRiskAcceptanceList

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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.
    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 RiskAcceptanceApi->notes_create:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RiskAcceptanceApi->notes_create: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this risk_ acceptance.
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

RiskAcceptanceToNotes notes_retrieve(id)

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.risk_acceptance_to_notes import RiskAcceptanceToNotes
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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.

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

Parameters

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

Return type

RiskAcceptanceToNotes

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

RiskAcceptance partial_update(id, patched_risk_acceptance_request=patched_risk_acceptance_request)

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.patched_risk_acceptance_request import PatchedRiskAcceptanceRequest
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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.
    patched_risk_acceptance_request = defectdojo_api_generated.PatchedRiskAcceptanceRequest() # PatchedRiskAcceptanceRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this risk_ acceptance.
patched_risk_acceptance_request	PatchedRiskAcceptanceRequest		[optional]

Return type

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
200		-

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

retrieve

RiskAcceptance retrieve(id)

Example

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

import defectdojo_api_generated
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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.

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

Parameters

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

Return type

RiskAcceptance

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

RiskAcceptance update(id, risk_acceptance_request)

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.risk_acceptance import RiskAcceptance
from defectdojo_api_generated.models.risk_acceptance_request import RiskAcceptanceRequest
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.RiskAcceptanceApi(api_client)
    id = 56 # int | A unique integer value identifying this risk_ acceptance.
    risk_acceptance_request = defectdojo_api_generated.RiskAcceptanceRequest() # RiskAcceptanceRequest | 

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this risk_ acceptance.
risk_acceptance_request	RiskAcceptanceRequest

Return type

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
200		-

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