defectdojo_api_generated.SystemSettingsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
list	GET /api/v2/system_settings/
partial_update	PATCH /api/v2/system_settings/{id}/
update	PUT /api/v2/system_settings/{id}/

list

PaginatedSystemSettingsList list(limit=limit, offset=offset)

Basic control over System Settings. Use 'id' 1 for PUT, PATCH operations

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.paginated_system_settings_list import PaginatedSystemSettingsList
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.SystemSettingsApi(api_client)
    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.list(limit=limit, offset=offset)
        print("The response of SystemSettingsApi->list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SystemSettingsApi->list: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	Number of results to return per page.	[optional]
offset	int	The initial index from which to return the results.	[optional]

Return type

PaginatedSystemSettingsList

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

SystemSettings partial_update(id, patched_system_settings_request=patched_system_settings_request)

Basic control over System Settings. Use 'id' 1 for PUT, PATCH operations

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.patched_system_settings_request import PatchedSystemSettingsRequest
from defectdojo_api_generated.models.system_settings import SystemSettings
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.SystemSettingsApi(api_client)
    id = 56 # int | A unique integer value identifying this system_ settings.
    patched_system_settings_request = defectdojo_api_generated.PatchedSystemSettingsRequest() # PatchedSystemSettingsRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this system_ settings.
patched_system_settings_request	PatchedSystemSettingsRequest		[optional]

Return type

SystemSettings

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

SystemSettings update(id, system_settings_request=system_settings_request)

Basic control over System Settings. Use 'id' 1 for PUT, PATCH operations

Example

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

import defectdojo_api_generated
from defectdojo_api_generated.models.system_settings import SystemSettings
from defectdojo_api_generated.models.system_settings_request import SystemSettingsRequest
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.SystemSettingsApi(api_client)
    id = 56 # int | A unique integer value identifying this system_ settings.
    system_settings_request = defectdojo_api_generated.SystemSettingsRequest() # SystemSettingsRequest |  (optional)

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

Parameters

Name	Type	Description	Notes
id	int	A unique integer value identifying this system_ settings.
system_settings_request	SystemSettingsRequest		[optional]

Return type

SystemSettings

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]