Sonatype Lifecycle Public REST API
Project description
sonatype-iq-api-client
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.182.0-01
- Package version: 1.0.0
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/sonatype-nexus-community/nexus-iq-api-client.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/sonatype-nexus-community/nexus-iq-api-client.git
)
Then import the package:
import sonatype_iq_api_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import sonatype_iq_api_client
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import sonatype_iq_api_client
from sonatype_iq_api_client.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 = sonatype_iq_api_client.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 = sonatype_iq_api_client.Configuration(
username = os.environ["USERNAME"],
password = os.environ["PASSWORD"]
)
# Enter a context with an instance of the API client
with sonatype_iq_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = sonatype_iq_api_client.AdvancedSearchApi(api_client)
try:
api_instance.create_search_index_async()
except ApiException as e:
print("Exception when calling AdvancedSearchApi->create_search_index_async: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
AdvancedSearchApi | create_search_index_async | POST /api/v2/search/advanced/index | |
AdvancedSearchApi | get_export_results | GET /api/v2/search/advanced/export/csv | |
AdvancedSearchApi | search_index | GET /api/v2/search/advanced | |
ApplicationCategoriesApi | add_tag | POST /api/v2/applicationCategories/organization/{organizationId} | |
ApplicationCategoriesApi | delete_tag | DELETE /api/v2/applicationCategories/organization/{organizationId}/{tagId} | |
ApplicationCategoriesApi | get_applicable_tags | GET /api/v2/applicationCategories/organization/{organizationId}/applicable | |
ApplicationCategoriesApi | get_applicable_tags_by_application_public_id | GET /api/v2/applicationCategories/application/{applicationPublicId}/applicable | |
ApplicationCategoriesApi | get_application_applicable_tags | GET /api/v2/applicationCategories/application/{applicationPublicId} | |
ApplicationCategoriesApi | get_applied_policy_tags | GET /api/v2/applicationCategories/organization/{organizationId}/policy | |
ApplicationCategoriesApi | get_applied_tags | GET /api/v2/applicationCategories/organization/{organizationId}/applied | |
ApplicationCategoriesApi | get_tags | GET /api/v2/applicationCategories/organization/{organizationId} | |
ApplicationCategoriesApi | get_tags_used_by_applications | GET /api/v2/applicationCategories/application | |
ApplicationCategoriesApi | update_tag | PUT /api/v2/applicationCategories/organization/{organizationId} | |
ApplicationReportDataApi | get_data | GET /api/v2/applications/{applicationPublicId}/reports/{scanId} | |
ApplicationReportDataApi | get_dependency_tree | GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree | |
ApplicationReportDataApi | get_policy_violation_diff | GET /api/v2/applications/{applicationPublicId}/reports/policyViolations/diff | |
ApplicationReportDataApi | get_policy_violations1 | GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/policy | |
ApplicationReportDataApi | get_raw_data | GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw | |
ApplicationsApi | add_application | POST /api/v2/applications | |
ApplicationsApi | clone_application | POST /api/v2/applications/{sourceApplicationId}/clone | |
ApplicationsApi | delete_application | DELETE /api/v2/applications/{applicationId} | |
ApplicationsApi | get_application | GET /api/v2/applications/{applicationId} | |
ApplicationsApi | get_applications | GET /api/v2/applications | |
ApplicationsApi | get_applications_by_organization_id | GET /api/v2/applications/organization/{organizationId} | |
ApplicationsApi | move_application | POST /api/v2/applications/{applicationId}/move/organization/{organizationId} | |
ApplicationsApi | update_application | PUT /api/v2/applications/{applicationId} | |
AuditLogsApi | get_audit_logs | GET /api/v2/auditLogs | |
ClaimApi | delete | DELETE /api/v2/claim/components/{hash} | |
ClaimApi | get | GET /api/v2/claim/components/{hash} | |
ClaimApi | get_all | GET /api/v2/claim/components | |
ClaimApi | set | POST /api/v2/claim/components | |
ComponentsApi | delete_component_label | DELETE /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId} | |
ComponentsApi | get_component_details | POST /api/v2/components/details | |
ComponentsApi | get_component_versions | POST /api/v2/components/versions | |
ComponentsApi | get_suggested_remediation_for_component | POST /api/v2/components/remediation/{ownerType}/{ownerId} | |
ComponentsApi | set_component_label | POST /api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId} | |
CompositeSourceControlApi | get_composite_source_control_by_owner | GET /api/v2/compositeSourceControl/{ownerType}/{internalOwnerId} | |
CompositeSourceControlConfigValidatorApi | validate_source_control_config | GET /api/v2/compositeSourceControlConfigValidator/application/{applicationId} | |
ConfigApi | delete_configuration | DELETE /api/v2/config | |
ConfigApi | disable_feature | DELETE /api/v2/config/features/{feature} | |
ConfigApi | enabled_feature | POST /api/v2/config/features/{feature} | |
ConfigApi | get_configuration | GET /api/v2/config | |
ConfigApi | set_configuration | PUT /api/v2/config | |
ConfigArtifactoryConnectionApi | add_artifactory_connection | POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId} | |
ConfigArtifactoryConnectionApi | delete_artifactory_connection | DELETE /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId} | |
ConfigArtifactoryConnectionApi | get_artifactory_connection | GET /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId} | |
ConfigArtifactoryConnectionApi | get_owner_artifactory_connection | GET /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId} | |
ConfigArtifactoryConnectionApi | test_artifactory_connection | POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/test | |
ConfigArtifactoryConnectionApi | test_artifactory_connection1 | POST /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId}/test | |
ConfigArtifactoryConnectionApi | update_artifactory_connection | PUT /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId}/{artifactoryConnectionId} | |
ConfigArtifactoryConnectionApi | update_owner_artifactory_connection_status | PUT /api/v2/config/artifactoryConnection/{ownerType}/{internalOwnerId} | |
ConfigCrowdApi | delete_crowd_configuration | DELETE /api/v2/config/crowd | |
ConfigCrowdApi | get_crowd_configuration | GET /api/v2/config/crowd | |
ConfigCrowdApi | insert_or_update_crowd_configuration | PUT /api/v2/config/crowd | |
ConfigCrowdApi | test_crowd_configuration | POST /api/v2/config/crowd/test | |
ConfigJIRAApi | delete_configuration1 | DELETE /api/v2/config/jira | |
ConfigJIRAApi | get_configuration1 | GET /api/v2/config/jira | |
ConfigJIRAApi | set_configuration1 | PUT /api/v2/config/jira | |
ConfigMailApi | delete_configuration2 | DELETE /api/v2/config/mail | |
ConfigMailApi | get_configuration2 | GET /api/v2/config/mail | |
ConfigMailApi | set_configuration2 | PUT /api/v2/config/mail | |
ConfigMailApi | test_configuration | POST /api/v2/config/mail/test/{recipientEmail} | |
ConfigProxyServerApi | delete_configuration3 | DELETE /api/v2/config/httpProxyServer | |
ConfigProxyServerApi | get_configuration3 | GET /api/v2/config/httpProxyServer | |
ConfigProxyServerApi | set_configuration3 | PUT /api/v2/config/httpProxyServer | |
ConfigReverseProxyAuthenticationApi | delete_configuration4 | DELETE /api/v2/config/reverseProxyAuthentication | |
ConfigReverseProxyAuthenticationApi | get_configuration4 | GET /api/v2/config/reverseProxyAuthentication | |
ConfigReverseProxyAuthenticationApi | set_configuration4 | PUT /api/v2/config/reverseProxyAuthentication | |
ConfigSAMLApi | delete_saml_configuration | DELETE /api/v2/config/saml | |
ConfigSAMLApi | get_metadata | GET /api/v2/config/saml/metadata | |
ConfigSAMLApi | get_saml_configuration | GET /api/v2/config/saml | |
ConfigSourceControlApi | delete_configuration5 | DELETE /api/v2/config/sourceControl | |
ConfigSourceControlApi | get_configuration5 | GET /api/v2/config/sourceControl | |
ConfigSourceControlApi | set_configuration5 | PUT /api/v2/config/sourceControl | |
CycloneDXApi | get_by_report_id | GET /api/v2/cycloneDx/{cdxVersion}/{applicationId}/reports/{reportId} | |
CycloneDXApi | get_latest | GET /api/v2/cycloneDx/{cdxVersion}/{applicationId}/stages/{stageId} | |
DataRetentionPoliciesApi | get_data_retention_policies | GET /api/v2/dataRetentionPolicies/organizations/{organizationId} | |
DataRetentionPoliciesApi | get_parent_data_retention_policies | GET /api/v2/dataRetentionPolicies/organizations/{organizationId}/parent | |
DataRetentionPoliciesApi | set_data_retention_policies | PUT /api/v2/dataRetentionPolicies/organizations/{organizationId} | |
EndpointsApi | get_open_api | GET /api/v2/endpoints/{apiType} | |
FirewallApi | add_repository_manager | POST /api/v2/firewall/repositoryManagers | |
FirewallApi | configure_repositories | POST /api/v2/firewall/repositories/configuration/{repositoryManagerId} | |
FirewallApi | delete_repository_manager | DELETE /api/v2/firewall/repositoryManagers/{repositoryManagerId} | |
FirewallApi | evaluate_components1 | POST /api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate | |
FirewallApi | get_configured_repositories | GET /api/v2/firewall/repositories/configuration/{repositoryManagerId} | |
FirewallApi | get_firewall_auto_unquarantine_config | GET /api/v2/firewall/releaseQuarantine/configuration | |
FirewallApi | get_firewall_metrics | GET /api/v2/firewall/metrics/embedded | |
FirewallApi | get_firewall_unquarantine_summary | GET /api/v2/firewall/releaseQuarantine/summary | |
FirewallApi | get_quarantine_list | GET /api/v2/firewall/components/quarantined | |
FirewallApi | get_quarantine_summary | GET /api/v2/firewall/quarantine/summary | |
FirewallApi | get_quarantined_component_view_anonymous_access | GET /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess | |
FirewallApi | get_repository_container | GET /api/v2/firewall/repositoryContainer | |
FirewallApi | get_repository_manager | GET /api/v2/firewall/repositoryManagers/{repositoryManagerId} | |
FirewallApi | get_repository_managers | GET /api/v2/firewall/repositoryManagers | |
FirewallApi | get_unquarantine_list | GET /api/v2/firewall/components/autoReleasedFromQuarantine | |
FirewallApi | set_firewall_auto_unquarantine_config | PUT /api/v2/firewall/releaseQuarantine/configuration | |
FirewallApi | set_quarantined_component_view_anonymous_access | PUT /api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled} | |
LabelsApi | add_label | POST /api/v2/labels/{ownerType}/{ownerId} | |
LabelsApi | delete_label | DELETE /api/v2/labels/{ownerType}/{ownerId}/{labelId} | |
LabelsApi | get_applicable_contexts | GET /api/v2/labels/{ownerType}/{ownerId}/applicable/context/{labelId} | |
LabelsApi | get_applicable_labels | GET /api/v2/labels/{ownerType}/{ownerId}/applicable | |
LabelsApi | get_labels | GET /api/v2/labels/{ownerType}/{ownerId} | |
LabelsApi | update_label | PUT /api/v2/labels/{ownerType}/{ownerId} | |
LicenseLegalMetadataApi | delete_attribution_report_template | DELETE /api/v2/licenseLegalMetadata/report-template/{id} | |
LicenseLegalMetadataApi | get_all_attribution_report_templates | GET /api/v2/licenseLegalMetadata/report-template | |
LicenseLegalMetadataApi | get_attribution_report_template_by_id | GET /api/v2/licenseLegalMetadata/report-template/{id} | |
LicenseLegalMetadataApi | get_license_legal_application_html_report | GET /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report | |
LicenseLegalMetadataApi | get_license_legal_application_report | GET /api/v2/licenseLegalMetadata/application/{applicationId} | |
LicenseLegalMetadataApi | get_license_legal_application_report1 | GET /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId} | |
LicenseLegalMetadataApi | get_license_legal_component_report | GET /api/v2/licenseLegalMetadata/{ownerType}/{ownerId}/component | |
LicenseLegalMetadataApi | get_license_legal_custom_application_html_report | POST /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report | |
LicenseLegalMetadataApi | get_license_legal_custom_application_html_report1 | POST /api/v2/licenseLegalMetadata/application/{applicationId}/stage/{stageId}/report/templateId/{templateId} | |
LicenseLegalMetadataApi | get_license_legal_custom_multi_application_html_report1 | POST /api/v2/licenseLegalMetadata/multiApplication/report/templateId/{templateId} | |
LicenseLegalMetadataApi | get_license_legal_multi_application_html_report | POST /api/v2/licenseLegalMetadata/multiApplication/report | |
LicenseLegalMetadataApi | get_license_legal_multi_application_report_from_active_user_filter | POST /api/v2/licenseLegalMetadata/multiApplication/activeUserFilter/report/templateId/{templateId} | |
LicenseLegalMetadataApi | save_attribution_report_template | POST /api/v2/licenseLegalMetadata/report-template | |
OrganizationsApi | add_organization | POST /api/v2/organizations | |
OrganizationsApi | delete_organization | DELETE /api/v2/organizations/{organizationId} | |
OrganizationsApi | get_organization | GET /api/v2/organizations/{organizationId} | |
OrganizationsApi | get_organizations | GET /api/v2/organizations | |
OrganizationsApi | move_organization | PUT /api/v2/organizations/{organizationId}/move/destination/{destinationId} | |
PoliciesApi | get_policies | GET /api/v2/policies | |
PolicyEvaluationApi | evaluate_components | POST /api/v2/evaluation/applications/{applicationId} | |
PolicyEvaluationApi | evaluate_source_control | POST /api/v2/evaluation/applications/{applicationId}/sourceControlEvaluation | |
PolicyEvaluationApi | get_application_evaluation_status | GET /api/v2/evaluation/applications/{applicationId}/status/{statusId} | |
PolicyEvaluationApi | get_component_evaluation | GET /api/v2/evaluation/applications/{applicationId}/results/{resultId} | |
PolicyEvaluationApi | promote_scan | POST /api/v2/evaluation/applications/{applicationId}/promoteScan | |
PolicyViolationDetailsApi | get_applicable_waivers | GET /api/v2/policyViolations/{violationId}/applicableWaivers | |
PolicyViolationDetailsApi | get_cross_stage_policy_violation_by_constituent_id | GET /api/v2/policyViolations/crossStage | |
PolicyViolationDetailsApi | get_cross_stage_policy_violation_by_id | GET /api/v2/policyViolations/crossStage/{violationId} | |
PolicyViolationDetailsApi | get_policy_violations | GET /api/v2/policyViolations | |
PolicyViolationDetailsApi | get_similar_waivers | GET /api/v2/policyViolations/{violationId}/similarWaivers | |
PolicyViolationDetailsApi | get_transitive_policy_violations_by_app_scan_component | GET /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/{scanId} | |
PolicyViolationDetailsApi | get_transitive_policy_violations_by_owner_stage_component | GET /api/v2/policyViolations/transitive/{ownerType}/{ownerId}/stages/{stageId} | |
PolicyWaiverReasonsApi | get_policy_waiver_reasons | GET /api/v2/policyWaiverReasons | |
PolicyWaiversApi | add_policy_waiver_by_policy_violation_id | POST /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyViolationId} | |
PolicyWaiversApi | add_waiver_to_transitive_policy_violations_by_app_scan_component | POST /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId} | |
PolicyWaiversApi | add_waiver_to_transitive_policy_violations_by_owner_stage_component | POST /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/stages/{stageId} | |
PolicyWaiversApi | delete_policy_waiver | DELETE /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId} | |
PolicyWaiversApi | get_policy_waiver | GET /api/v2/policyWaivers/{ownerType}/{ownerId}/{policyWaiverId} | |
PolicyWaiversApi | get_policy_waivers | GET /api/v2/policyWaivers/{ownerType}/{ownerId} | |
PolicyWaiversApi | get_transitive_policy_waivers_by_app_scan_component | GET /api/v2/policyWaivers/transitive/{ownerType}/{ownerId}/{scanId} | |
PolicyWaiversApi | request_policy_waiver | POST /api/v2/policyWaivers/waiverRequests/{policyViolationId} | |
ReportsApi | get_all1 | GET /api/v2/reports/applications | |
ReportsApi | get_by_application_id | GET /api/v2/reports/applications/{applicationId} | |
ReportsApi | get_components_in_quarantine | GET /api/v2/reports/components/quarantined | |
ReportsApi | get_components_with_waivers | GET /api/v2/reports/components/waivers | |
ReportsApi | get_metrics | POST /api/v2/reports/metrics | |
ReportsApi | get_report_history_for_application | GET /api/v2/reports/applications/{applicationId}/history | |
ReportsApi | get_stale_waivers | GET /api/v2/reports/waivers/stale | |
RepositoriesApi | get_quarantined_by_path | POST /api/v2/repositories/{repositoryManagerInstanceId}/{repositoryPublicId}/components/quarantined/pathnames | |
RepositoriesApi | release_quarantine_without_re_eval | POST /api/v2/repositories/quarantine/{quarantineId}/release | |
RoleMembershipsApi | get_role_memberships_application_or_organization | GET /api/v2/roleMemberships/{ownerType}/{internalOwnerId} | |
RoleMembershipsApi | get_role_memberships_global_or_repository_container | GET /api/v2/roleMemberships/{ownerType} | |
RoleMembershipsApi | grant_role_membership_application_or_organization | PUT /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName} | |
RoleMembershipsApi | grant_role_membership_global_or_repository_container | PUT /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName} | |
RoleMembershipsApi | revoke_role_membership_application_or_organization | DELETE /api/v2/roleMemberships/{ownerType}/{internalOwnerId}/role/{roleId}/{memberType}/{memberName} | |
RoleMembershipsApi | revoke_role_membership_global_or_repository_container | DELETE /api/v2/roleMemberships/{ownerType}/role/{roleId}/{memberType}/{memberName} | |
RolesApi | get_roles | GET /api/v2/roles | |
ScanApi | get_ide_users_overview | GET /api/v2/scan/applications/ideUser/overview | |
ScanApi | get_scan_status | GET /api/v2/scan/applications/{applicationId}/status/{scanRequestId} | |
ScanApi | scan_components | POST /api/v2/scan/applications/{applicationId}/sources/{source} | |
SearchApi | search_component | GET /api/v2/search/component | |
SecurityOverridesApi | get_security_vulnerability_overrides | GET /api/v2/securityOverrides | |
SolutionsApi | get_licensed_solutions | GET /api/v2/solutions/licensed | |
SourceControlApi | add_source_control | POST /api/v2/sourceControl/{ownerType}/{internalOwnerId} | |
SourceControlApi | automatic_role_assignment | POST /api/v2/sourceControl/automaticRoleAssignment/{publicId} | |
SourceControlApi | delete_source_control | DELETE /api/v2/sourceControl/{ownerType}/{internalOwnerId} | |
SourceControlApi | get_source_control1 | GET /api/v2/sourceControl/{ownerType}/{internalOwnerId} | |
SourceControlApi | update_source_control | PUT /api/v2/sourceControl/{ownerType}/{internalOwnerId} | |
SourceControlMetricsApi | get_source_control | GET /api/v2/sourceControlMetrics/{ownerType}/{internalOwnerId} | |
SpdxApi | get_by_scan_id | GET /api/v2/spdx/{applicationId}/reports/{scanId} | |
SpdxApi | get_latest_for_stage | GET /api/v2/spdx/{applicationId}/stages/{stageId} | |
TelemetryApi | post_external_telemetry | POST /api/v2/telemetry | |
UserTokensApi | create_user_token | POST /api/v2/userTokens/currentUser | |
UserTokensApi | delete_current_user_token | DELETE /api/v2/userTokens/currentUser | |
UserTokensApi | delete_user_token_by_user_code | DELETE /api/v2/userTokens/userCode/{userCode} | |
UserTokensApi | get_user_token_by_username_and_realm_id | GET /api/v2/userTokens/{username} | |
UserTokensApi | get_user_token_exists_for_current_user | GET /api/v2/userTokens/currentUser/hasToken | |
UserTokensApi | get_user_tokens_by_created_between_and_realm_id | GET /api/v2/userTokens | |
UserTokensApi | purge_user_tokens | DELETE /api/v2/userTokens/purge | |
UsersApi | add | POST /api/v2/users | |
UsersApi | delete1 | DELETE /api/v2/users/{username} | |
UsersApi | get1 | GET /api/v2/users/{username} | |
UsersApi | get_all2 | GET /api/v2/users | |
UsersApi | update | PUT /api/v2/users/{username} | |
VulnerabilitiesApi | get_security_vulnerability_details | GET /api/v2/vulnerabilities/{refId} | |
SbomApi | delete_sbom_version | DELETE /api/v2/sbom/applications/{applicationId}/versions/{version} | Delete sbom version |
SbomApi | delete_vulnerability_analysis | DELETE /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis | Deletes a Vulnerability analysis for a given component. |
SbomApi | get_active_sbom_version_list_by_application | GET /api/v2/sbom/applications/{applicationId}/versions | Gets a list of active sbom versions by application id |
SbomApi | get_import_status | GET /api/v2/sbom/applications/{applicationId}/status/{importRequestId} | Get sbom import status |
SbomApi | get_sbom_components | GET /api/v2/sbom/applications/{applicationId}/versions/{version}/components | Gets the components found in a specific sbom version |
SbomApi | get_sbom_metadata_summary_for_application | GET /api/v2/sbom/applications/{applicationId} | Gets a paginated list of SBOMs for an application |
SbomApi | get_sbom_version | GET /api/v2/sbom/applications/{applicationId}/versions/{version} | Gets a sbom version |
SbomApi | import_sbom | POST /api/v2/sbom/import | Import a new sbom version |
SbomApi | save_vulnerability_analysis | PUT /api/v2/sbom/applications/{applicationId}/versions/{version}/vulnerability/{refId}/analysis | Updates a vulnerability analysis annotation for a specific SBOM vulnerability |
Documentation For Models
- Action
- ApiApplicationBaseDTO
- ApiApplicationCategoryDTO
- ApiApplicationDTO
- ApiApplicationEvaluationCommitDTO
- ApiApplicationEvaluationResultDTOV2
- ApiApplicationEvaluationStatusDTOV2
- ApiApplicationListDTO
- ApiApplicationReportDTOV2
- ApiApplicationTagDTO
- ApiApplicationViolationDTOV2
- ApiApplicationViolationListDTOV2
- ApiApplicationWaiverDTO
- ApiArtifactoryConnectionDTO
- ApiArtifactoryConnectionStatusRequestDTO
- ApiArtifactoryConnectionStatusResponseDTO
- ApiComponentChangeActionDTO
- ApiComponentDTOV2
- ApiComponentDetailsDTOV2
- ApiComponentDetailsRequestDTOV2
- ApiComponentDetailsResultDTOV2
- ApiComponentEvaluationRequestDTOV2
- ApiComponentEvaluationResultDTOV2
- ApiComponentEvaluationTicketDTOV2
- ApiComponentIdentifierDTOV2
- ApiComponentOrPurlIdentifierDTOV2
- ApiComponentPolicyViolationDTO
- ApiComponentPolicyViolationListDTOV2
- ApiComponentPolicyWaiversDTO
- ApiComponentProjectDataDTO
- ApiComponentProjectMetadataDTO
- ApiComponentProjectScmDTO
- ApiComponentProjectScmDetailsDTO
- ApiComponentProjectScmMetadataDTO
- ApiComponentReleasedFromQuarantineDTO
- ApiComponentRemediationDTO
- ApiComponentRemediationValueDTO
- ApiComponentTransitivePolicyViolationsDTO
- ApiComponentWaiversDTO
- ApiComponentsInQuarantineDTO
- ApiCompositeSourceControlDTO
- ApiCompositeValueDTOBoolean
- ApiCompositeValueDTOString
- ApiConditionFactReasonDTO
- ApiConstraintFactDTO
- ApiConstraintViolationDTO
- ApiConstraintViolationReasonDTO
- ApiCrossStageViolationDTOV2
- ApiCrowdConfigurationDTO
- ApiDataRetentionPoliciesDTO
- ApiDependencyDataDTO
- ApiDependencyTreeNodeDTO
- ApiDependencyTreeResponseDTO
- ApiEnhancedPolicyViolationDTOV2
- ApiEvaluationResultCounterDTO
- ApiFirewallMetricsResultDTO
- ApiFirewallQuarantineSummaryDTO
- ApiFirewallReleaseQuarantineConfigDTO
- ApiFirewallReleaseQuarantineSummaryDTO
- ApiGlobalInformationDTOV2
- ApiHashComponentIdentifierDTO
- ApiHashComponentIdentifiersDTO
- ApiJiraConfigurationDTO
- ApiLabelDTO
- ApiLicenseDTO
- ApiLicenseDataDTO
- ApiLicenseDataDTOV2
- ApiLicenseLegalApplicationReportDTO
- ApiLicenseLegalComponentDTO
- ApiLicenseLegalComponentReportDTO
- ApiLicenseLegalCopyrightDTO
- ApiLicenseLegalDataDTO
- ApiLicenseLegalFileDTO
- ApiLicenseLegalMetadataDTO
- ApiLicenseLegalObligationDTO
- ApiLicenseLegalStageScanDTO
- ApiLicenseThreatDTOV2
- ApiLicensedSolutionDTO
- ApiMailConfigurationDTO
- ApiMatchStateSummaryDTOV2
- ApiMemberDTO
- ApiMetricsReportingQueryDTOV2
- ApiMoveApplicationResponseDTOV2
- ApiOrganizationDTO
- ApiOrganizationListDTO
- ApiOwnerArtifactoryConnectionDTO
- ApiOwnerDTO
- ApiPolicyDTO
- ApiPolicyListDTO
- ApiPolicyViolationDTOV2
- ApiPolicyViolationDiffDTO
- ApiPolicyViolationForDiffDTO
- ApiPolicyViolationStageDTO
- ApiPolicyWaiverDTO
- ApiPolicyWaiverReasonDTO
- ApiPolicyWaiversApplicableToViolationDTO
- ApiPromoteScanRequestDTOV2
- ApiProxyServerConfigurationDTO
- ApiPullRequestResult
- ApiPullRequestResults
- ApiReportComponentDTOV2
- ApiReportComponentPolicyViolationsDTOV2
- ApiReportConstraintConditionDTOV2
- ApiReportConstraintViolationDTOV2
- ApiReportHistoryDTO
- ApiReportPolicyDataDTOV2
- ApiReportPolicyViolationDTOV2
- ApiReportRawDataDTOV2
- ApiReportResultsDTO
- ApiReportRetentionPoliciesDTO
- ApiReportRetentionPolicyDTO
- ApiRepositoryComponentDTO
- ApiRepositoryComponentEvaluationRequest
- ApiRepositoryComponentEvaluationRequestList
- ApiRepositoryComponentEvaluationResult
- ApiRepositoryComponentEvaluationResultList
- ApiRepositoryComponentPath
- ApiRepositoryComponentPolicyViolationDTO
- ApiRepositoryComponentsInQuarantineDTO
- ApiRepositoryContainerDTO
- ApiRepositoryDTO
- ApiRepositoryListDTO
- ApiRepositoryManagerDTO
- ApiRepositoryManagerListDTO
- ApiRepositoryPathResponseDTO
- ApiRepositoryPathVersions
- ApiRepositoryWaiverDTO
- ApiRequestPolicyWaiverDTO
- ApiReverseProxyAuthenticationConfigurationDTO
- ApiRoleDTO
- ApiRoleListDTO
- ApiRoleMemberMappingDTO
- ApiRoleMemberMappingListDTO
- ApiSamlConfigurationDTO
- ApiSamlConfigurationResponseDTO
- ApiSbomStatusDTO
- ApiSearchCriteriaDTOV2
- ApiSearchResultDTOV2
- ApiSearchResultsDTOV2
- ApiSecurityDataDTO
- ApiSecurityIssueAnalysisDTO
- ApiSecurityIssueDTO
- ApiSecurityVulnerabilityOverrideDTOV2
- ApiSecurityVulnerabilityOverrideResponseDTOV2
- ApiSourceControlConfigurationDTO
- ApiSourceControlDTO
- ApiSourceControlEvaluationRequestDTO
- ApiStagePolicyViolationComponentDTO
- ApiStaleApplicationEvaluationDTO
- ApiStaleEvaluationStageDTO
- ApiStaleEvaluationsDTO
- ApiStaleRepositoryEvaluationDTO
- ApiStaleWaiverDTO
- ApiStaleWaiversResponseDTO
- ApiStatusDTO
- ApiSuccessMetricsRetentionPolicyDTO
- ApiSuggestedVersionChangeOptionDTO
- ApiTagDTO
- ApiThirdPartyScanResultDTO
- ApiThirdPartyScanTicketDTO
- ApiUserDTO
- ApiUserListDTO
- ApiUserTokenDTO
- ApiUserTokenExistsDTO
- ApiVersionChangeOptionDTO
- ApiWaivedPolicyViolationDTO
- ApiWaiverOptionsDTO
- ApplicableContext
- ApplicableLabels
- ApplicableTagsDTO
- ApplicationTag
- ApplicationTagsByOwnerDTO
- AppliedTagsDTO
- AttachmentText
- AttributionReportTemplateDTO
- BodyPart
- BodyPartMediaType
- ComponentDisplayName
- ComponentDisplayNamePart
- ComponentFact
- ComponentIdentifier
- ComponentLocator
- ComponentObligationAttributionDTO
- ConditionFact
- ConfigurationValidationResult
- ConstraintFact
- ContentDisposition
- CweId
- FormDataBodyPart
- FormDataContentDisposition
- FormDataMultiPart
- GroupingByDTO
- IdeUsersOverviewDTO
- ImportSbomRequest
- InnerSourceData
- LabelsByOwner
- LegalSourceLinkDTO
- License
- LicenseObligationDTO
- LicenseThreatGroupDTO
- MultiPart
- ParameterizedHeader
- PolicyAlert
- PolicyEvaluationResult
- PolicyFact
- PolicyOwner
- PolicyTag
- ReferenceLink
- RootCause
- SBOMVulnerabilityAnalysisRequest
- SbomComponentDTO
- SbomComponentListDTO
- SearchResultDTO
- SearchResultItemDTO
- SecurityVulnerabilityCustomData
- SecurityVulnerabilityData
- SecurityVulnerabilitySeverity
- SecurityVulnerabilityWeakness
- StageData
- Swid
- SystemConfig
- SystemConfigProperty
- TagsByOwnerDTO
- ThirdPartySbomMetadataSummaryDTO
- ThirdPartySbomMetadataSummaryListDTO
- TriggerReference
- ValidationResult
- VulnerabilityAnalysis
- VulnerabilitySource
Documentation For Authorization
Authentication schemes defined for the API:
BasicAuth
- Type: HTTP basic authentication
Author
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sonatype_iq_api_client-0.183.0.tar.gz
.
File metadata
- Download URL: sonatype_iq_api_client-0.183.0.tar.gz
- Upload date:
- Size: 168.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.1 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fcd024324abd39c093499f8298fc4f2c2927eb2798ac791c710dcc082b2fae6 |
|
MD5 | 652d1d5068d489a8c8db323d5f917720 |
|
BLAKE2b-256 | 9eb33c77bb0d313d6e1ec62f03509c9aa592640a17c43f84b8232f75d85bc04e |
File details
Details for the file sonatype_iq_api_client-0.183.0-py3-none-any.whl
.
File metadata
- Download URL: sonatype_iq_api_client-0.183.0-py3-none-any.whl
- Upload date:
- Size: 525.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.1 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1fdc8cb4db48b607e6f3f925ab0f83e4a146d7cfcf46f171cc06c1ffb316cdb3 |
|
MD5 | ffdab903ce6f9fa7cdf41340981bad02 |
|
BLAKE2b-256 | afd36879469cd24ba14e32d51bdae6d77c89a03d7cc72a45b79d1a98ffa470c8 |