defectdojo-api-generated

DefectDojo - Open Source vulnerability Management made easy. Prefetch related parameters/responses not yet in the schema.

The defectdojo_api_generated package is automatically generated by the OpenAPI Generator project:

  • API/package version: 2.57.2
  • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

To use this package, add it to your project:

pip install defectdojo-api-generated

# or if you're using uv
uv add defectdojo-api-generated

Getting Started

In your own code, to use this library to connect and interact with defectdojo-api-generated, you can run the following:

    from defectdojo_api_generated import DefectDojo

    # password publicly available in https://github.com/DefectDojo/django-DefectDojo/?tab=readme-ov-file#demo
    dojo = DefectDojo(base_url='https://demo.defectdojo.org/', auth=('admin', PASSWORD))
    for ind, finding in enumerate(dojo.findings_api.list_iterator(title='Stored XSS')):
        if not ind:
            print(f'Total matched findings: {finding.page.count}')
        print(f'- [{finding.result.severity}] {finding.result.title} - {finding.result.description}')
    r = dojo.system_settings_api.list(limit=1)
    print(f'- {r.results[0]}')

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AnnouncementsApi create POST /api/v2/announcements/
AnnouncementsApi delete_preview_list GET /api/v2/announcements/{id}/delete_preview/
AnnouncementsApi destroy DELETE /api/v2/announcements/{id}/
AnnouncementsApi list GET /api/v2/announcements/
AnnouncementsApi partial_update PATCH /api/v2/announcements/{id}/
AnnouncementsApi retrieve GET /api/v2/announcements/{id}/
AnnouncementsApi update PUT /api/v2/announcements/{id}/
ApiTokenAuthApi create POST /api/v2/api-token-auth/
AssetApiScanConfigurationsApi create POST /api/v2/asset_api_scan_configurations/
AssetApiScanConfigurationsApi delete_preview_list GET /api/v2/asset_api_scan_configurations/{id}/delete_preview/
AssetApiScanConfigurationsApi destroy DELETE /api/v2/asset_api_scan_configurations/{id}/
AssetApiScanConfigurationsApi list GET /api/v2/asset_api_scan_configurations/
AssetApiScanConfigurationsApi partial_update PATCH /api/v2/asset_api_scan_configurations/{id}/
AssetApiScanConfigurationsApi retrieve GET /api/v2/asset_api_scan_configurations/{id}/
AssetApiScanConfigurationsApi update PUT /api/v2/asset_api_scan_configurations/{id}/
AssetGroupsApi create POST /api/v2/asset_groups/
AssetGroupsApi delete_preview_list GET /api/v2/asset_groups/{id}/delete_preview/
AssetGroupsApi destroy DELETE /api/v2/asset_groups/{id}/
AssetGroupsApi list GET /api/v2/asset_groups/
AssetGroupsApi retrieve GET /api/v2/asset_groups/{id}/
AssetGroupsApi update PUT /api/v2/asset_groups/{id}/
AssetMembersApi create POST /api/v2/asset_members/
AssetMembersApi delete_preview_list GET /api/v2/asset_members/{id}/delete_preview/
AssetMembersApi destroy DELETE /api/v2/asset_members/{id}/
AssetMembersApi list GET /api/v2/asset_members/
AssetMembersApi retrieve GET /api/v2/asset_members/{id}/
AssetMembersApi update PUT /api/v2/asset_members/{id}/
AssetsApi create POST /api/v2/assets/
AssetsApi delete_preview_list GET /api/v2/assets/{id}/delete_preview/
AssetsApi destroy DELETE /api/v2/assets/{id}/
AssetsApi generate_report_create POST /api/v2/assets/{id}/generate_report/
AssetsApi list GET /api/v2/assets/
AssetsApi partial_update PATCH /api/v2/assets/{id}/
AssetsApi retrieve GET /api/v2/assets/{id}/
AssetsApi update PUT /api/v2/assets/{id}/
CeleryApi queue_details_list GET /api/v2/celery/queue/details/ Get per-task breakdown of the Celery queue
CeleryApi queue_purge_create POST /api/v2/celery/queue/purge/ Purge all pending Celery tasks from the queue
CeleryApi queue_task_purge_create POST /api/v2/celery/queue/task/purge/ Purge all queued tasks with a given task name
CeleryApi status_retrieve GET /api/v2/celery/status/ Get Celery worker and queue status
ConfigurationPermissionsApi list GET /api/v2/configuration_permissions/
ConfigurationPermissionsApi retrieve GET /api/v2/configuration_permissions/{id}/
CredentialMappingsApi create POST /api/v2/credential_mappings/
CredentialMappingsApi delete_preview_list GET /api/v2/credential_mappings/{id}/delete_preview/
CredentialMappingsApi destroy DELETE /api/v2/credential_mappings/{id}/
CredentialMappingsApi list GET /api/v2/credential_mappings/
CredentialMappingsApi partial_update PATCH /api/v2/credential_mappings/{id}/
CredentialMappingsApi retrieve GET /api/v2/credential_mappings/{id}/
CredentialMappingsApi update PUT /api/v2/credential_mappings/{id}/
CredentialsApi create POST /api/v2/credentials/
CredentialsApi delete_preview_list GET /api/v2/credentials/{id}/delete_preview/
CredentialsApi destroy DELETE /api/v2/credentials/{id}/
CredentialsApi list GET /api/v2/credentials/
CredentialsApi partial_update PATCH /api/v2/credentials/{id}/
CredentialsApi retrieve GET /api/v2/credentials/{id}/
CredentialsApi update PUT /api/v2/credentials/{id}/
DevelopmentEnvironmentsApi create POST /api/v2/development_environments/
DevelopmentEnvironmentsApi delete_preview_list GET /api/v2/development_environments/{id}/delete_preview/
DevelopmentEnvironmentsApi destroy DELETE /api/v2/development_environments/{id}/
DevelopmentEnvironmentsApi list GET /api/v2/development_environments/
DevelopmentEnvironmentsApi partial_update PATCH /api/v2/development_environments/{id}/
DevelopmentEnvironmentsApi retrieve GET /api/v2/development_environments/{id}/
DevelopmentEnvironmentsApi update PUT /api/v2/development_environments/{id}/
DojoGroupMembersApi create POST /api/v2/dojo_group_members/
DojoGroupMembersApi delete_preview_list GET /api/v2/dojo_group_members/{id}/delete_preview/
DojoGroupMembersApi destroy DELETE /api/v2/dojo_group_members/{id}/
DojoGroupMembersApi list GET /api/v2/dojo_group_members/
DojoGroupMembersApi retrieve GET /api/v2/dojo_group_members/{id}/
DojoGroupMembersApi update PUT /api/v2/dojo_group_members/{id}/
DojoGroupsApi create POST /api/v2/dojo_groups/
DojoGroupsApi delete_preview_list GET /api/v2/dojo_groups/{id}/delete_preview/
DojoGroupsApi destroy DELETE /api/v2/dojo_groups/{id}/
DojoGroupsApi list GET /api/v2/dojo_groups/
DojoGroupsApi partial_update PATCH /api/v2/dojo_groups/{id}/
DojoGroupsApi retrieve GET /api/v2/dojo_groups/{id}/
DojoGroupsApi update PUT /api/v2/dojo_groups/{id}/
EndpointMetaImportApi create POST /api/v2/endpoint_meta_import/
EndpointStatusApi create POST /api/v2/endpoint_status/
EndpointStatusApi delete_preview_list GET /api/v2/endpoint_status/{id}/delete_preview/
EndpointStatusApi destroy DELETE /api/v2/endpoint_status/{id}/
EndpointStatusApi list GET /api/v2/endpoint_status/
EndpointStatusApi partial_update PATCH /api/v2/endpoint_status/{id}/
EndpointStatusApi retrieve GET /api/v2/endpoint_status/{id}/
EndpointStatusApi update PUT /api/v2/endpoint_status/{id}/
EndpointsApi create POST /api/v2/endpoints/
EndpointsApi delete_preview_list GET /api/v2/endpoints/{id}/delete_preview/
EndpointsApi destroy DELETE /api/v2/endpoints/{id}/
EndpointsApi generate_report_create POST /api/v2/endpoints/{id}/generate_report/
EndpointsApi list GET /api/v2/endpoints/
EndpointsApi partial_update PATCH /api/v2/endpoints/{id}/
EndpointsApi retrieve GET /api/v2/endpoints/{id}/
EndpointsApi update PUT /api/v2/endpoints/{id}/
EngagementPresetsApi create POST /api/v2/engagement_presets/
EngagementPresetsApi delete_preview_list GET /api/v2/engagement_presets/{id}/delete_preview/
EngagementPresetsApi destroy DELETE /api/v2/engagement_presets/{id}/
EngagementPresetsApi list GET /api/v2/engagement_presets/
EngagementPresetsApi partial_update PATCH /api/v2/engagement_presets/{id}/
EngagementPresetsApi retrieve GET /api/v2/engagement_presets/{id}/
EngagementPresetsApi update PUT /api/v2/engagement_presets/{id}/
EngagementsApi accept_risks_create POST /api/v2/engagements/{id}/accept_risks/
EngagementsApi close_create POST /api/v2/engagements/{id}/close/
EngagementsApi complete_checklist_create POST /api/v2/engagements/{id}/complete_checklist/
EngagementsApi complete_checklist_retrieve GET /api/v2/engagements/{id}/complete_checklist/
EngagementsApi create POST /api/v2/engagements/
EngagementsApi delete_preview_list GET /api/v2/engagements/{id}/delete_preview/
EngagementsApi destroy DELETE /api/v2/engagements/{id}/
EngagementsApi files_create POST /api/v2/engagements/{id}/files/
EngagementsApi files_download_retrieve GET /api/v2/engagements/{id}/files/download/{file_id}/
EngagementsApi files_retrieve GET /api/v2/engagements/{id}/files/
EngagementsApi generate_report_create POST /api/v2/engagements/{id}/generate_report/
EngagementsApi list GET /api/v2/engagements/
EngagementsApi notes_create POST /api/v2/engagements/{id}/notes/
EngagementsApi notes_retrieve GET /api/v2/engagements/{id}/notes/
EngagementsApi partial_update PATCH /api/v2/engagements/{id}/
EngagementsApi reopen_create POST /api/v2/engagements/{id}/reopen/
EngagementsApi retrieve GET /api/v2/engagements/{id}/
EngagementsApi update PUT /api/v2/engagements/{id}/
EngagementsApi update_jira_epic_create POST /api/v2/engagements/{id}/update_jira_epic/
FindingTemplatesApi create POST /api/v2/finding_templates/
FindingTemplatesApi delete_preview_list GET /api/v2/finding_templates/{id}/delete_preview/
FindingTemplatesApi destroy DELETE /api/v2/finding_templates/{id}/
FindingTemplatesApi list GET /api/v2/finding_templates/
FindingTemplatesApi partial_update PATCH /api/v2/finding_templates/{id}/
FindingTemplatesApi retrieve GET /api/v2/finding_templates/{id}/
FindingTemplatesApi update PUT /api/v2/finding_templates/{id}/
FindingsApi accept_risks_create POST /api/v2/findings/accept_risks/
FindingsApi close_create POST /api/v2/findings/{id}/close/
FindingsApi create POST /api/v2/findings/
FindingsApi delete_preview_list GET /api/v2/findings/{id}/delete_preview/
FindingsApi destroy DELETE /api/v2/findings/{id}/
FindingsApi duplicate_list GET /api/v2/findings/{id}/duplicate/
FindingsApi duplicate_reset_create POST /api/v2/findings/{id}/duplicate/reset/
FindingsApi files_create POST /api/v2/findings/{id}/files/
FindingsApi files_download_retrieve GET /api/v2/findings/{id}/files/download/{file_id}/
FindingsApi files_retrieve GET /api/v2/findings/{id}/files/
FindingsApi generate_report_create POST /api/v2/findings/generate_report/
FindingsApi list GET /api/v2/findings/
FindingsApi metadata_create POST /api/v2/findings/{id}/metadata/
FindingsApi metadata_destroy DELETE /api/v2/findings/{id}/metadata/
FindingsApi metadata_list GET /api/v2/findings/{id}/metadata/
FindingsApi metadata_update PUT /api/v2/findings/{id}/metadata/
FindingsApi notes_create POST /api/v2/findings/{id}/notes/
FindingsApi notes_retrieve GET /api/v2/findings/{id}/notes/
FindingsApi original_create POST /api/v2/findings/{id}/original/{new_fid}/
FindingsApi partial_update PATCH /api/v2/findings/{id}/
FindingsApi remove_note_partial_update PATCH /api/v2/findings/{id}/remove_note/
FindingsApi remove_tags_partial_update PATCH /api/v2/findings/{id}/remove_tags/
FindingsApi remove_tags_update PUT /api/v2/findings/{id}/remove_tags/
FindingsApi request_response_create POST /api/v2/findings/{id}/request_response/
FindingsApi request_response_retrieve GET /api/v2/findings/{id}/request_response/
FindingsApi retrieve GET /api/v2/findings/{id}/
FindingsApi tags_create POST /api/v2/findings/{id}/tags/
FindingsApi tags_retrieve GET /api/v2/findings/{id}/tags/
FindingsApi update PUT /api/v2/findings/{id}/
FindingsApi verify_create POST /api/v2/findings/{id}/verify/
GlobalRolesApi create POST /api/v2/global_roles/
GlobalRolesApi delete_preview_list GET /api/v2/global_roles/{id}/delete_preview/
GlobalRolesApi destroy DELETE /api/v2/global_roles/{id}/
GlobalRolesApi list GET /api/v2/global_roles/
GlobalRolesApi partial_update PATCH /api/v2/global_roles/{id}/
GlobalRolesApi retrieve GET /api/v2/global_roles/{id}/
GlobalRolesApi update PUT /api/v2/global_roles/{id}/
ImportLanguagesApi create POST /api/v2/import-languages/
ImportScanApi create POST /api/v2/import-scan/
JiraConfigurationsApi create POST /api/v2/jira_configurations/
JiraConfigurationsApi delete_preview_list GET /api/v2/jira_configurations/{id}/delete_preview/
JiraConfigurationsApi destroy DELETE /api/v2/jira_configurations/{id}/
JiraConfigurationsApi list GET /api/v2/jira_configurations/
JiraConfigurationsApi partial_update PATCH /api/v2/jira_configurations/{id}/
JiraConfigurationsApi retrieve GET /api/v2/jira_configurations/{id}/
JiraConfigurationsApi update PUT /api/v2/jira_configurations/{id}/
JiraFindingMappingsApi create POST /api/v2/jira_finding_mappings/
JiraFindingMappingsApi delete_preview_list GET /api/v2/jira_finding_mappings/{id}/delete_preview/
JiraFindingMappingsApi destroy DELETE /api/v2/jira_finding_mappings/{id}/
JiraFindingMappingsApi list GET /api/v2/jira_finding_mappings/
JiraFindingMappingsApi partial_update PATCH /api/v2/jira_finding_mappings/{id}/
JiraFindingMappingsApi retrieve GET /api/v2/jira_finding_mappings/{id}/
JiraFindingMappingsApi update PUT /api/v2/jira_finding_mappings/{id}/
JiraInstancesApi create POST /api/v2/jira_instances/
JiraInstancesApi delete_preview_list GET /api/v2/jira_instances/{id}/delete_preview/
JiraInstancesApi destroy DELETE /api/v2/jira_instances/{id}/
JiraInstancesApi list GET /api/v2/jira_instances/
JiraInstancesApi partial_update PATCH /api/v2/jira_instances/{id}/
JiraInstancesApi retrieve GET /api/v2/jira_instances/{id}/
JiraInstancesApi update PUT /api/v2/jira_instances/{id}/
JiraProductConfigurationsApi create POST /api/v2/jira_product_configurations/
JiraProductConfigurationsApi delete_preview_list GET /api/v2/jira_product_configurations/{id}/delete_preview/
JiraProductConfigurationsApi destroy DELETE /api/v2/jira_product_configurations/{id}/
JiraProductConfigurationsApi list GET /api/v2/jira_product_configurations/
JiraProductConfigurationsApi partial_update PATCH /api/v2/jira_product_configurations/{id}/
JiraProductConfigurationsApi retrieve GET /api/v2/jira_product_configurations/{id}/
JiraProductConfigurationsApi update PUT /api/v2/jira_product_configurations/{id}/
JiraProjectsApi create POST /api/v2/jira_projects/
JiraProjectsApi delete_preview_list GET /api/v2/jira_projects/{id}/delete_preview/
JiraProjectsApi destroy DELETE /api/v2/jira_projects/{id}/
JiraProjectsApi list GET /api/v2/jira_projects/
JiraProjectsApi partial_update PATCH /api/v2/jira_projects/{id}/
JiraProjectsApi retrieve GET /api/v2/jira_projects/{id}/
JiraProjectsApi update PUT /api/v2/jira_projects/{id}/
LanguageTypesApi create POST /api/v2/language_types/
LanguageTypesApi delete_preview_list GET /api/v2/language_types/{id}/delete_preview/
LanguageTypesApi destroy DELETE /api/v2/language_types/{id}/
LanguageTypesApi list GET /api/v2/language_types/
LanguageTypesApi partial_update PATCH /api/v2/language_types/{id}/
LanguageTypesApi retrieve GET /api/v2/language_types/{id}/
LanguageTypesApi update PUT /api/v2/language_types/{id}/
LanguagesApi create POST /api/v2/languages/
LanguagesApi delete_preview_list GET /api/v2/languages/{id}/delete_preview/
LanguagesApi destroy DELETE /api/v2/languages/{id}/
LanguagesApi list GET /api/v2/languages/
LanguagesApi partial_update PATCH /api/v2/languages/{id}/
LanguagesApi retrieve GET /api/v2/languages/{id}/
LanguagesApi update PUT /api/v2/languages/{id}/
MetadataApi batch_create POST /api/v2/metadata/batch/
MetadataApi batch_partial_update PATCH /api/v2/metadata/batch/
MetadataApi create POST /api/v2/metadata/
MetadataApi delete_preview_list GET /api/v2/metadata/{id}/delete_preview/
MetadataApi destroy DELETE /api/v2/metadata/{id}/
MetadataApi list GET /api/v2/metadata/
MetadataApi partial_update PATCH /api/v2/metadata/{id}/
MetadataApi retrieve GET /api/v2/metadata/{id}/
MetadataApi update PUT /api/v2/metadata/{id}/
NetworkLocationsApi create POST /api/v2/network_locations/
NetworkLocationsApi delete_preview_list GET /api/v2/network_locations/{id}/delete_preview/
NetworkLocationsApi destroy DELETE /api/v2/network_locations/{id}/
NetworkLocationsApi list GET /api/v2/network_locations/
NetworkLocationsApi partial_update PATCH /api/v2/network_locations/{id}/
NetworkLocationsApi retrieve GET /api/v2/network_locations/{id}/
NetworkLocationsApi update PUT /api/v2/network_locations/{id}/
NoteTypeApi create POST /api/v2/note_type/
NoteTypeApi delete_preview_list GET /api/v2/note_type/{id}/delete_preview/
NoteTypeApi destroy DELETE /api/v2/note_type/{id}/
NoteTypeApi list GET /api/v2/note_type/
NoteTypeApi partial_update PATCH /api/v2/note_type/{id}/
NoteTypeApi retrieve GET /api/v2/note_type/{id}/
NoteTypeApi update PUT /api/v2/note_type/{id}/
NotesApi list GET /api/v2/notes/
NotesApi partial_update PATCH /api/v2/notes/{id}/
NotesApi retrieve GET /api/v2/notes/{id}/
NotesApi update PUT /api/v2/notes/{id}/
NotificationWebhooksApi create POST /api/v2/notification_webhooks/
NotificationWebhooksApi delete_preview_list GET /api/v2/notification_webhooks/{id}/delete_preview/
NotificationWebhooksApi destroy DELETE /api/v2/notification_webhooks/{id}/
NotificationWebhooksApi list GET /api/v2/notification_webhooks/
NotificationWebhooksApi partial_update PATCH /api/v2/notification_webhooks/{id}/
NotificationWebhooksApi retrieve GET /api/v2/notification_webhooks/{id}/
NotificationWebhooksApi update PUT /api/v2/notification_webhooks/{id}/
NotificationsApi create POST /api/v2/notifications/
NotificationsApi delete_preview_list GET /api/v2/notifications/{id}/delete_preview/
NotificationsApi destroy DELETE /api/v2/notifications/{id}/
NotificationsApi list GET /api/v2/notifications/
NotificationsApi partial_update PATCH /api/v2/notifications/{id}/
NotificationsApi retrieve GET /api/v2/notifications/{id}/
NotificationsApi update PUT /api/v2/notifications/{id}/
Oa3Api schema_retrieve GET /api/v2/oa3/schema/
OrganizationGroupsApi create POST /api/v2/organization_groups/
OrganizationGroupsApi delete_preview_list GET /api/v2/organization_groups/{id}/delete_preview/
OrganizationGroupsApi destroy DELETE /api/v2/organization_groups/{id}/
OrganizationGroupsApi list GET /api/v2/organization_groups/
OrganizationGroupsApi retrieve GET /api/v2/organization_groups/{id}/
OrganizationGroupsApi update PUT /api/v2/organization_groups/{id}/
OrganizationMembersApi create POST /api/v2/organization_members/
OrganizationMembersApi delete_preview_list GET /api/v2/organization_members/{id}/delete_preview/
OrganizationMembersApi destroy DELETE /api/v2/organization_members/{id}/
OrganizationMembersApi list GET /api/v2/organization_members/
OrganizationMembersApi retrieve GET /api/v2/organization_members/{id}/
OrganizationMembersApi update PUT /api/v2/organization_members/{id}/
OrganizationsApi create POST /api/v2/organizations/
OrganizationsApi delete_preview_list GET /api/v2/organizations/{id}/delete_preview/
OrganizationsApi destroy DELETE /api/v2/organizations/{id}/
OrganizationsApi generate_report_create POST /api/v2/organizations/{id}/generate_report/
OrganizationsApi list GET /api/v2/organizations/
OrganizationsApi partial_update PATCH /api/v2/organizations/{id}/
OrganizationsApi retrieve GET /api/v2/organizations/{id}/
OrganizationsApi update PUT /api/v2/organizations/{id}/
ProductApiScanConfigurationsApi create POST /api/v2/product_api_scan_configurations/
ProductApiScanConfigurationsApi delete_preview_list GET /api/v2/product_api_scan_configurations/{id}/delete_preview/
ProductApiScanConfigurationsApi destroy DELETE /api/v2/product_api_scan_configurations/{id}/
ProductApiScanConfigurationsApi list GET /api/v2/product_api_scan_configurations/
ProductApiScanConfigurationsApi partial_update PATCH /api/v2/product_api_scan_configurations/{id}/
ProductApiScanConfigurationsApi retrieve GET /api/v2/product_api_scan_configurations/{id}/
ProductApiScanConfigurationsApi update PUT /api/v2/product_api_scan_configurations/{id}/
ProductGroupsApi create POST /api/v2/product_groups/
ProductGroupsApi delete_preview_list GET /api/v2/product_groups/{id}/delete_preview/
ProductGroupsApi destroy DELETE /api/v2/product_groups/{id}/
ProductGroupsApi list GET /api/v2/product_groups/
ProductGroupsApi retrieve GET /api/v2/product_groups/{id}/
ProductGroupsApi update PUT /api/v2/product_groups/{id}/
ProductMembersApi create POST /api/v2/product_members/
ProductMembersApi delete_preview_list GET /api/v2/product_members/{id}/delete_preview/
ProductMembersApi destroy DELETE /api/v2/product_members/{id}/
ProductMembersApi list GET /api/v2/product_members/
ProductMembersApi retrieve GET /api/v2/product_members/{id}/
ProductMembersApi update PUT /api/v2/product_members/{id}/
ProductTypeGroupsApi create POST /api/v2/product_type_groups/
ProductTypeGroupsApi delete_preview_list GET /api/v2/product_type_groups/{id}/delete_preview/
ProductTypeGroupsApi destroy DELETE /api/v2/product_type_groups/{id}/
ProductTypeGroupsApi list GET /api/v2/product_type_groups/
ProductTypeGroupsApi retrieve GET /api/v2/product_type_groups/{id}/
ProductTypeGroupsApi update PUT /api/v2/product_type_groups/{id}/
ProductTypeMembersApi create POST /api/v2/product_type_members/
ProductTypeMembersApi delete_preview_list GET /api/v2/product_type_members/{id}/delete_preview/
ProductTypeMembersApi destroy DELETE /api/v2/product_type_members/{id}/
ProductTypeMembersApi list GET /api/v2/product_type_members/
ProductTypeMembersApi retrieve GET /api/v2/product_type_members/{id}/
ProductTypeMembersApi update PUT /api/v2/product_type_members/{id}/
ProductTypesApi create POST /api/v2/product_types/
ProductTypesApi delete_preview_list GET /api/v2/product_types/{id}/delete_preview/
ProductTypesApi destroy DELETE /api/v2/product_types/{id}/
ProductTypesApi generate_report_create POST /api/v2/product_types/{id}/generate_report/
ProductTypesApi list GET /api/v2/product_types/
ProductTypesApi partial_update PATCH /api/v2/product_types/{id}/
ProductTypesApi retrieve GET /api/v2/product_types/{id}/
ProductTypesApi update PUT /api/v2/product_types/{id}/
ProductsApi create POST /api/v2/products/
ProductsApi delete_preview_list GET /api/v2/products/{id}/delete_preview/
ProductsApi destroy DELETE /api/v2/products/{id}/
ProductsApi generate_report_create POST /api/v2/products/{id}/generate_report/
ProductsApi list GET /api/v2/products/
ProductsApi partial_update PATCH /api/v2/products/{id}/
ProductsApi retrieve GET /api/v2/products/{id}/
ProductsApi update PUT /api/v2/products/{id}/
QuestionnaireAnsweredQuestionnairesApi list GET /api/v2/questionnaire_answered_questionnaires/
QuestionnaireAnsweredQuestionnairesApi retrieve GET /api/v2/questionnaire_answered_questionnaires/{id}/
QuestionnaireAnswersApi list GET /api/v2/questionnaire_answers/
QuestionnaireAnswersApi retrieve GET /api/v2/questionnaire_answers/{id}/
QuestionnaireEngagementQuestionnairesApi link_engagement_create POST /api/v2/questionnaire_engagement_questionnaires/{id}/link_engagement/{engagement_id}/
QuestionnaireEngagementQuestionnairesApi list GET /api/v2/questionnaire_engagement_questionnaires/
QuestionnaireEngagementQuestionnairesApi retrieve GET /api/v2/questionnaire_engagement_questionnaires/{id}/
QuestionnaireGeneralQuestionnairesApi list GET /api/v2/questionnaire_general_questionnaires/
QuestionnaireGeneralQuestionnairesApi retrieve GET /api/v2/questionnaire_general_questionnaires/{id}/
QuestionnaireQuestionsApi list GET /api/v2/questionnaire_questions/
QuestionnaireQuestionsApi retrieve GET /api/v2/questionnaire_questions/{id}/
RegulationsApi create POST /api/v2/regulations/
RegulationsApi delete_preview_list GET /api/v2/regulations/{id}/delete_preview/
RegulationsApi destroy DELETE /api/v2/regulations/{id}/
RegulationsApi list GET /api/v2/regulations/
RegulationsApi partial_update PATCH /api/v2/regulations/{id}/
RegulationsApi retrieve GET /api/v2/regulations/{id}/
RegulationsApi update PUT /api/v2/regulations/{id}/
ReimportScanApi create POST /api/v2/reimport-scan/
RequestResponsePairsApi create POST /api/v2/request_response_pairs/
RequestResponsePairsApi delete_preview_list GET /api/v2/request_response_pairs/{id}/delete_preview/
RequestResponsePairsApi destroy DELETE /api/v2/request_response_pairs/{id}/
RequestResponsePairsApi list GET /api/v2/request_response_pairs/
RequestResponsePairsApi partial_update PATCH /api/v2/request_response_pairs/{id}/
RequestResponsePairsApi retrieve GET /api/v2/request_response_pairs/{id}/
RequestResponsePairsApi update PUT /api/v2/request_response_pairs/{id}/
RiskAcceptanceApi create POST /api/v2/risk_acceptance/
RiskAcceptanceApi delete_preview_list GET /api/v2/risk_acceptance/{id}/delete_preview/
RiskAcceptanceApi destroy DELETE /api/v2/risk_acceptance/{id}/
RiskAcceptanceApi download_proof_retrieve GET /api/v2/risk_acceptance/{id}/download_proof/
RiskAcceptanceApi list GET /api/v2/risk_acceptance/
RiskAcceptanceApi notes_create POST /api/v2/risk_acceptance/{id}/notes/
RiskAcceptanceApi notes_retrieve GET /api/v2/risk_acceptance/{id}/notes/
RiskAcceptanceApi partial_update PATCH /api/v2/risk_acceptance/{id}/
RiskAcceptanceApi retrieve GET /api/v2/risk_acceptance/{id}/
RiskAcceptanceApi update PUT /api/v2/risk_acceptance/{id}/
RolesApi list GET /api/v2/roles/
RolesApi retrieve GET /api/v2/roles/{id}/
SlaConfigurationsApi create POST /api/v2/sla_configurations/
SlaConfigurationsApi delete_preview_list GET /api/v2/sla_configurations/{id}/delete_preview/
SlaConfigurationsApi destroy DELETE /api/v2/sla_configurations/{id}/
SlaConfigurationsApi list GET /api/v2/sla_configurations/
SlaConfigurationsApi partial_update PATCH /api/v2/sla_configurations/{id}/
SlaConfigurationsApi retrieve GET /api/v2/sla_configurations/{id}/
SlaConfigurationsApi update PUT /api/v2/sla_configurations/{id}/
SonarqubeIssuesApi create POST /api/v2/sonarqube_issues/
SonarqubeIssuesApi delete_preview_list GET /api/v2/sonarqube_issues/{id}/delete_preview/
SonarqubeIssuesApi destroy DELETE /api/v2/sonarqube_issues/{id}/
SonarqubeIssuesApi list GET /api/v2/sonarqube_issues/
SonarqubeIssuesApi partial_update PATCH /api/v2/sonarqube_issues/{id}/
SonarqubeIssuesApi retrieve GET /api/v2/sonarqube_issues/{id}/
SonarqubeIssuesApi update PUT /api/v2/sonarqube_issues/{id}/
SonarqubeTransitionsApi create POST /api/v2/sonarqube_transitions/
SonarqubeTransitionsApi delete_preview_list GET /api/v2/sonarqube_transitions/{id}/delete_preview/
SonarqubeTransitionsApi destroy DELETE /api/v2/sonarqube_transitions/{id}/
SonarqubeTransitionsApi list GET /api/v2/sonarqube_transitions/
SonarqubeTransitionsApi partial_update PATCH /api/v2/sonarqube_transitions/{id}/
SonarqubeTransitionsApi retrieve GET /api/v2/sonarqube_transitions/{id}/
SonarqubeTransitionsApi update PUT /api/v2/sonarqube_transitions/{id}/
StubFindingsApi create POST /api/v2/stub_findings/
StubFindingsApi delete_preview_list GET /api/v2/stub_findings/{id}/delete_preview/
StubFindingsApi destroy DELETE /api/v2/stub_findings/{id}/
StubFindingsApi list GET /api/v2/stub_findings/
StubFindingsApi partial_update PATCH /api/v2/stub_findings/{id}/
StubFindingsApi retrieve GET /api/v2/stub_findings/{id}/
StubFindingsApi update PUT /api/v2/stub_findings/{id}/
SystemSettingsApi list GET /api/v2/system_settings/
SystemSettingsApi partial_update PATCH /api/v2/system_settings/{id}/
SystemSettingsApi update PUT /api/v2/system_settings/{id}/
TechnologiesApi create POST /api/v2/technologies/
TechnologiesApi delete_preview_list GET /api/v2/technologies/{id}/delete_preview/
TechnologiesApi destroy DELETE /api/v2/technologies/{id}/
TechnologiesApi list GET /api/v2/technologies/
TechnologiesApi partial_update PATCH /api/v2/technologies/{id}/
TechnologiesApi retrieve GET /api/v2/technologies/{id}/
TechnologiesApi update PUT /api/v2/technologies/{id}/
TestImportsApi create POST /api/v2/test_imports/
TestImportsApi delete_preview_list GET /api/v2/test_imports/{id}/delete_preview/
TestImportsApi destroy DELETE /api/v2/test_imports/{id}/
TestImportsApi list GET /api/v2/test_imports/
TestImportsApi partial_update PATCH /api/v2/test_imports/{id}/
TestImportsApi retrieve GET /api/v2/test_imports/{id}/
TestImportsApi update PUT /api/v2/test_imports/{id}/
TestTypesApi create POST /api/v2/test_types/
TestTypesApi list GET /api/v2/test_types/
TestTypesApi partial_update PATCH /api/v2/test_types/{id}/
TestTypesApi retrieve GET /api/v2/test_types/{id}/
TestTypesApi update PUT /api/v2/test_types/{id}/
TestsApi accept_risks_create POST /api/v2/tests/{id}/accept_risks/
TestsApi create POST /api/v2/tests/
TestsApi delete_preview_list GET /api/v2/tests/{id}/delete_preview/
TestsApi destroy DELETE /api/v2/tests/{id}/
TestsApi files_create POST /api/v2/tests/{id}/files/
TestsApi files_download_retrieve GET /api/v2/tests/{id}/files/download/{file_id}/
TestsApi files_retrieve GET /api/v2/tests/{id}/files/
TestsApi generate_report_create POST /api/v2/tests/{id}/generate_report/
TestsApi list GET /api/v2/tests/
TestsApi notes_create POST /api/v2/tests/{id}/notes/
TestsApi notes_retrieve GET /api/v2/tests/{id}/notes/
TestsApi partial_update PATCH /api/v2/tests/{id}/
TestsApi retrieve GET /api/v2/tests/{id}/
TestsApi update PUT /api/v2/tests/{id}/
ToolConfigurationsApi create POST /api/v2/tool_configurations/
ToolConfigurationsApi delete_preview_list GET /api/v2/tool_configurations/{id}/delete_preview/
ToolConfigurationsApi destroy DELETE /api/v2/tool_configurations/{id}/
ToolConfigurationsApi list GET /api/v2/tool_configurations/
ToolConfigurationsApi partial_update PATCH /api/v2/tool_configurations/{id}/
ToolConfigurationsApi retrieve GET /api/v2/tool_configurations/{id}/
ToolConfigurationsApi update PUT /api/v2/tool_configurations/{id}/
ToolProductSettingsApi create POST /api/v2/tool_product_settings/
ToolProductSettingsApi delete_preview_list GET /api/v2/tool_product_settings/{id}/delete_preview/
ToolProductSettingsApi destroy DELETE /api/v2/tool_product_settings/{id}/
ToolProductSettingsApi list GET /api/v2/tool_product_settings/
ToolProductSettingsApi partial_update PATCH /api/v2/tool_product_settings/{id}/
ToolProductSettingsApi retrieve GET /api/v2/tool_product_settings/{id}/
ToolProductSettingsApi update PUT /api/v2/tool_product_settings/{id}/
ToolTypesApi create POST /api/v2/tool_types/
ToolTypesApi delete_preview_list GET /api/v2/tool_types/{id}/delete_preview/
ToolTypesApi destroy DELETE /api/v2/tool_types/{id}/
ToolTypesApi list GET /api/v2/tool_types/
ToolTypesApi partial_update PATCH /api/v2/tool_types/{id}/
ToolTypesApi retrieve GET /api/v2/tool_types/{id}/
ToolTypesApi update PUT /api/v2/tool_types/{id}/
UserContactInfosApi create POST /api/v2/user_contact_infos/
UserContactInfosApi delete_preview_list GET /api/v2/user_contact_infos/{id}/delete_preview/
UserContactInfosApi destroy DELETE /api/v2/user_contact_infos/{id}/
UserContactInfosApi list GET /api/v2/user_contact_infos/
UserContactInfosApi partial_update PATCH /api/v2/user_contact_infos/{id}/
UserContactInfosApi retrieve GET /api/v2/user_contact_infos/{id}/
UserContactInfosApi update PUT /api/v2/user_contact_infos/{id}/
UserProfileApi retrieve GET /api/v2/user_profile/
UsersApi create POST /api/v2/users/
UsersApi delete_preview_list GET /api/v2/users/{id}/delete_preview/
UsersApi destroy DELETE /api/v2/users/{id}/
UsersApi list GET /api/v2/users/
UsersApi partial_update PATCH /api/v2/users/{id}/
UsersApi reset_api_token_create POST /api/v2/users/{id}/reset_api_token/
UsersApi retrieve GET /api/v2/users/{id}/
UsersApi update PUT /api/v2/users/{id}/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location:

tokenAuth

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