{"openapi":"3.0.1","info":{"title":"Sonatype Lifecycle Public REST API","version":"1.206.0-01"},"security":[{"BasicAuth":[],"BearerAuth":[]}],"tags":[{"name":"Advanced Search","description":"Use the Advanced Search REST API to perform searches on Lifecycle application scan reports."},{"name":"Application Categories","description":"Use the Application Categories REST API to manage the application categories or tags assigned to the applications in an organization. "},{"name":"Application Report Data","description":"Use this REST API to retrieve the data from an application composition report, that is generated after an evaluation."},{"name":"Applications","description":"Use this REST API to manage applications.\n\nIn addition to the primary functions of create, update and delete, you can also move applications from one organization to other."},{"name":"Audit Logs","description":"Use this REST API to access the IQ Server audit logs."},{"name":"Auto Policy Waiver Exclusions","description":"Use this REST API to create and delete auto policy waiver exclusions."},{"name":"Auto Policy Waivers","description":"Use this REST API to create, modify and retrieve auto policy waivers."},{"name":"CI Configuration","description":"Use this REST API to manage CI integration configuration. Configurations can be set at organization or application level and are merged from the organization hierarchy with lower levels taking precedence."},{"name":"Claim Components","description":"Use this REST API to manage components that are developed in-house and are not open-source.\n\nClaiming the component stores the identity information for the component hash and avoids triggering the Component-Unknown policy.\n\nComponents will have a match state as `Exact` and Identification Source as `Manual`,\nfor subsequent scans or evaluations."},{"name":"Component Labels","description":"Use this REST API to manage component labels for applications, organizations and repositories.\n\nComponent Labels can be used as attributes of a component at the time of creating policies. A policy violation can be triggered based on the component label."},{"name":"Component Search","description":"Use this REST API to search for components in application evaluation reports."},{"name":"Components","description":"Use this REST API to retrieve a component's security vulnerability data, license data, age and popularity."},{"name":"Composite Source Control","description":"Use this REST API to access the composite source control management configuration (SCM) for an application or organization.\n\nComposite source control configuration is defined as the configuration that is inherited from the parent organization or is directly assigned."},{"name":"Composite Source Control Validator","description":"Use this REST API to validate the composite source control management (SCM) configuration.\n\nComposite source control configuration is defined as the configuration that is inherited from the parent or is directly assigned."},{"name":"Config Crowd","description":"Use this REST API to manage the configuration of an existing Atlassian Crowd Server that is being used to authenticate users for IQ Server."},{"name":"Config Jira","description":"Use this REST API to manage Jira configurations to receive notifications from Lifecycle.\n\nIt is supported for Jira Cloud, Jira Server, and Jira Data Center."},{"name":"Config Mail","description":"Use this REST API to manage the configuration of an SMTP server, to receive email notifications."},{"name":"Config OIDC","description":"Use this REST API to manage the OIDC configuration for IQ Server."},{"name":"Config Proxy Server","description":"Use this REST API to manage the configuration of IQ Server with an existing HTTP proxy server."},{"name":"Config Reverse Proxy Authentication","description":"Use this REST API to manage the configuration of a reverse proxy server."},{"name":"Config SAML","description":"Use this REST API to manage the SAML configuration for IQ Server."},{"name":"Config Source Control","description":"Use this REST API to manage the configuration of IQ Server with your Source Control Management (SCM) system (e.g. GitHub)."},{"name":"Config Zscaler","description":"Use this REST API to manage the configuration of a Zscaler service."},{"name":"Configuration","description":"Use this REST API to configure the IQ Server system properties.\n\nWe strongly recommend using this REST API instead of config.yml for versions 142 and higher."},{"name":"Configure Artifactory Connection","description":"Use this REST API to manage the configuration of Firewall for JFrog Artifactory."},{"name":"Consumption"},{"name":"CPE Matching Configuration","description":"Use the CPE Matching Configuration REST API to add/set/remove cpe matching configuration to organizations and applications"},{"name":"CycloneDX","description":"Use the CycloneDX REST API to generate CycloneDX SBOMs in XML or JSON formats, containing coordinates and licenses for components found in a scan report."},{"name":"Data Retention Policies","description":"Set policies for automatic purging of obsolete application and Success Metrics reports.

Note that IQ Server has a preset limit of purging 5000 reports in one execution of its report purging job."},{"name":"Developer Priorities","description":"Use this REST API to export Sonatype Developer component priorities data, including security reachability data."},{"name":"Endpoints","description":"This REST API returns the OpenAPI documentation for the specified IQ Server REST API."},{"name":"Feature Configuration","description":"Use this REST API to enable/disable the IQ Server features."},{"name":"Firewall","description":"Use this REST API for managing and monitoring firewall features, including metrics, repository management, quarantine operations, and namespace confusion prevention."},{"name":"GitHub App"},{"name":"GitHub App Configuration","description":"GitHub App configuration operations"},{"name":"Legacy Violations","description":"Use this REST API to list, grant, and revoke legacy status for policy violations of an application."},{"name":"Legacy Violations Configuration","description":"Use this REST API to view and update legacy-violation configuration for an application or organization."},{"name":"License Legal Metadata Report","description":"Use this REST API to retrieve license legal metadata in raw or HTML format."},{"name":"License Legal Metadata Template","description":"Use this REST API to manage and customize templates for the license legal metadata generated in HTML format."},{"name":"License Overrides","description":"Use this REST API to manage license overrides for components in your applicationsorganizations and repositories."},{"name":"Organizations","description":"Use this REST API to create new organizations, retrieve, edit or delete existing organizations."},{"name":"Policies","description":"Use this REST API to retrieve details on all existing policies in your instance of Lifecycle."},{"name":"Policy Evaluation","description":"Use this REST API to perform an application policy evaluation. Policy evaluations are executed asynchronously.

This is a 2-step process that involves: \n1. Requesting a policy evaluation (POST) \n2. Checking the status and response of the evaluation request (GET)"},{"name":"Policy Export","description":"Export policy configurations for organizations, applications, and repositories"},{"name":"Policy Violation Details","description":"Use this REST API to obtain the violation details, violation details across stages (cross stage), violations occurring due to transitive dependencies and all waivers applicable to a violation.\n\nCross-stage policy violations are helpful in performance analysis like MTTR metrics."},{"name":"Policy Waiver Reasons","description":"Use this rest API to fetch available policy waiver reasons"},{"name":"Policy Waiver Requests","description":"Use this REST API to manage policy waiver requests."},{"name":"Policy Waivers","description":"Use this REST API to create and retrieve policy waivers."},{"name":"Product License","description":"Use this REST API to manage a product license."},{"name":"Reachability Evidence","description":"Use this REST API to retrieve reachability evidence showing call paths to vulnerable methods."},{"name":"Reports","description":"Use this REST API to view application scan reports, generate a list of stale waivers, view existing policy waivers on components, view quarantined components and retrieve additional metrics data. "},{"name":"Repositories","description":"Use this REST API to manage quarantined components."},{"name":"Role Memberships","description":"Use this REST API to manage authorizations for users or user groups.\n\nYou can view existing role assignments and grant or revoke user authorization on organizations, applications and repositories."},{"name":"Roles","description":"Roles provide sets of permissions that grant access to the functionality in the user interface, through integrations, and when using REST APIs.\n\nPermissions are granted by assigning users or groups to the system roles or at the various levels in the organizational hierarchy: root organization, repository managers, and applications and organizations.\n\nUse this REST API to manage roles."},{"name":"Scan Health Configuration","description":"Use this REST API to manage Scan Health configuration. This includes settings for\nfailing scans with zero components detected. Configurations can be set at organization\nor application level and are inherited from the organization hierarchy."},{"name":"Security Vulnerability Overrides","description":"Use this REST API to retrieve security vulnerabilities that have been overridden."},{"name":"Solutions"},{"name":"Source Control","description":"Use this REST API to:

"},{"name":"Source Control Metrics","description":"Use this REST API to view the response times of a source control evaluation."},{"name":"SPDX","description":"Use this REST API to generate SPDX SBOMs in XML or JSON formats."},{"name":"Third-Party Analysis","description":"Use this REST API to scan SBOMs for your applications."},{"name":"User Token Configuration","description":"Use this REST API to manage user token expiration configuration."},{"name":"User Tokens","description":"Use this REST API to manage user tokens."},{"name":"Users","description":"Use this REST API to manage users."},{"name":"Vulnerability Details","description":"Use this REST API to retrieve vulnerability details."},{"name":"Waiver Expiration Notification Config","description":"Configure when and to whom notifications are sent before waivers expire."}],"paths":{"/api/v2/search/advanced/index":{"post":{"tags":["Advanced Search"],"description":"Use this method to create or rebuild the index for Advanced Search. This is a resource intensive operation. Avoid creating indexes during peak usage hours.\n\nPermissions required: Edit System Configuration and Users","operationId":"createSearchIndexAsync","responses":{"204":{"description":"Index created successfully."}}}},"/api/v2/search/advanced/export/csv":{"get":{"tags":["Advanced Search"],"description":"Use this method to generate a csv file containing your search results. The default delimiter in the generated file is comma. Use the advancedSearchCSVExportDelimiter property of the Configuration REST API to change the delimiter in the generated file.","operationId":"getExportResults","parameters":[{"name":"query","in":"query","description":"A well-formed search query.","required":true,"schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Enter the no. of results that should be visible per page, unset gives all results","schema":{"type":"integer","format":"int32"}},{"name":"page","in":"query","description":"Enter the page no. for the page containing results","schema":{"type":"integer","format":"int32"}},{"name":"allComponents","in":"query","description":"Set to `true` to retrieve results that include components with no violations.","schema":{"type":"boolean","default":false}},{"name":"mode","in":"query","schema":{"type":"string","enum":["sbomManager"]}}],"responses":{"200":{"description":"Downloadable csv file generated successfully."},"409":{"description":"Search index does not exist or is unreadable."}}}},"/api/v2/search/advanced":{"get":{"tags":["Advanced Search"],"description":"Use this method to perform an Advanced Search. ","operationId":"searchIndex","parameters":[{"name":"query","in":"query","description":"Enter your search query here","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Enter the no. of results that should be visible per page","schema":{"type":"integer","format":"int32","default":10}},{"name":"page","in":"query","description":"Enter the page no. for the page containing results","schema":{"type":"integer","format":"int32"}},{"name":"allComponents","in":"query","description":"Set to `true` to retrieve results that include components with no violations","schema":{"type":"boolean","default":false}},{"name":"mode","in":"query","schema":{"type":"string","enum":["sbomManager"]}}],"responses":{"409":{"description":"Search index not found. The Advanced Search index is unavailable or has not been created yet. Re-indexing is required before results can be returned."},"200":{"description":"Response JSON containing the search query sent in the API call, and other response fields as follows: \n1. searchQuery: search query sent in the request \n2. page: page number of search results requested \n3. pageSize: requested number of results per page \n4. totalNumberOfHits: total number of results returned \n5. isExactTotalNumberOfHits \n * `true` indicates that the search results in the JSON is the same no. of search results that logically match the search query. \n * `false` indicates that the search results in the JSON are lower bound because fetching all results is too expensive to compute. \n6. groupingByDTOS: array of search results grouped on a field name \n7. groupIdentifier: field name that the search results have been grouped by \n8. groupBy: field value that the search results have been grouped by \n9. additionalInfo: shared information between groups, e.g. info if grouped by a security vulnerability \n10. searchResultItemDTOS: array of search results with each element containing an itemType, field names and values \n11. resultIndex: indicating the relevance of the search result w.r.t. the query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultDTO"}}}}}}},"/api/v2/applicationCategories/organization/{organizationId}":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories in use by applications in this organization.","operationId":"getTags","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of application categories or tags that can be used by applications in this organization. Each application category consists of an id, name, description and color. ","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}}}}}},"put":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to update an existing application category.","operationId":"updateTag","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Specify the id (application category id) and id of the organization that owns this application category, to update the name, description and color.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}},"required":true},"responses":{"200":{"description":"Successful update echoing the updated application category details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}}}}},"post":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to add a new application category or tag.","operationId":"addTag","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server, for which you want to create the application category.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Specify the the name, description and color for the new application category to be created. The application category id is not required to create a new application category and should not be included.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}},"required":true},"responses":{"200":{"description":"Successful creation of the new application category and its details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}}}}}},"/api/v2/applicationCategories/organization/{organizationId}/{tagId}":{"delete":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to update an existing application category.Use this method to delete an existing application category.","operationId":"deleteTag","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server, corresponding to the application category tag you want to delete.","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","description":"The application category ID assigned by IQ Server, to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful deletion of the application category."}}}},"/api/v2/applicationCategories/organization/{organizationId}/applicable":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories that can be applied to applications in this organization.","operationId":"getApplicableTags","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server, for which you want to retrieve the applicable tags or application categories.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of application categories or tags that can be applied to applications in this organization. Each application category or tag consists of an id, name, description and color. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicableTagsDTO"}}}}}}},"/api/v2/applicationCategories/application/{applicationPublicId}/applicable":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories that can be applied to applications in this organization.","operationId":"getApplicableTagsByApplicationPublicId","parameters":[{"name":"applicationPublicId","in":"path","description":"Provide the application public ID assigned by IQ Server.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns all application categories or tags that can be applied to this application, by providing the application public ID.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}}}}}}},"/api/v2/applicationCategories/application/{applicationPublicId}":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories available to applications in this organization.","operationId":"getApplicationApplicableTags","parameters":[{"name":"applicationPublicId","in":"path","description":"The application public ID ","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"A list of application categories that can be applied to the specified application. Each application category or tag consists of an id, name, description and color. ","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicableTagsDTO"}}}}}}},"/api/v2/applicationCategories/organization/{organizationId}/policy":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories that are applied to applications in this organization.","operationId":"getAppliedPolicyTags","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get all policy application categories or tags that are applied to applications in this organization.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTag"}}}}}}}},"/api/v2/applicationCategories/organization/{organizationId}/applied":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories that can be applied to applications in this organization.","operationId":"getAppliedTags","parameters":[{"name":"organizationId","in":"path","description":"The organizationId assigned by IQ Server.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get all application categories or tags that can be applied to an application, belonging to the organization specified by the organization id.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppliedTagsDTO"}}}}}}},"/api/v2/applicationCategories/application":{"get":{"tags":["Application Categories"],"description":"Grouping applications with similar characteristics into categories makes policy management easier. You can then create a policy that applies to a specific category. Use this method to retrieve a list of application categories.","operationId":"getTagsUsedByApplications","responses":{"200":{"description":"A list of application categories or tags applied to applications. Each application category or tag consists of an id, name, description and color.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiApplicationCategoryDTO"}}}}}}}},"/api/v2/applications":{"get":{"tags":["Applications"],"description":"Use this method to retrieve the application details for the applicationId(s) provided.\n\nPermissions required: View IQ Elements","operationId":"getApplications","parameters":[{"name":"publicId","in":"query","description":"Enter the applicationId.","schema":{"uniqueItems":true,"type":"array","items":{"type":"string"}}},{"name":"includeCategories","in":"query","description":"Set this parameter to `true` to obtain the application tags (application categories) in the response.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returns either a list of applications or a list of applications with category tags depending on the `includeCategories` parameter.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ApiApplicationListDTO"},{"$ref":"#/components/schemas/ApiApplicationCategoriesListDTO"}]}}}}}},"post":{"tags":["Applications"],"description":"Use this method to create an application under an organization. Use the Organization REST API to obtain organizationId.\n\nPermissions required: Add Application (on parent organization)","operationId":"addApplication","requestBody":{"description":"Specify the applicationId, application name and the organizationId under which the application should be created. `contactUserName` corresponds to the 'contact' field in the UI and represents the user name. If LDAP is used for authentication, you can use LDAP usernames.`tagId` is the internal identifier for the Application Category that you want to apply to the application. Use the Application Categories REST API for the available categories and the corresponding tagIds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationDTO"}}}},"responses":{"200":{"description":"The response contains application details for the application created using this method.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationDTO"}}}}}}},"/api/v2/applications/{sourceApplicationId}/clone":{"post":{"tags":["Applications"],"description":"Use this method to clone an existing application.\n\nPermissions required: Add Application (on the parent organization)","operationId":"cloneApplication","parameters":[{"name":"sourceApplicationId","in":"path","description":"Enter the applicationId for the application to be cloned.","required":true,"schema":{"type":"string"}},{"name":"clonedApplicationName","in":"query","description":"Enter the application name for the new cloned application.","schema":{"type":"string"}},{"name":"clonedApplicationPublicId","in":"query","description":"Enter the applicationPublicId for the cloned application.","schema":{"type":"string"}}],"responses":{"200":{"description":"The response contains application details of the cloned application.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationDTO"}}}}}}},"/api/v2/applications/{applicationId}":{"get":{"tags":["Applications"],"description":"Use this method to retrieve the application details, by providing the applicationId.\n\nPermissions required: View IQ Elements","operationId":"getApplication","parameters":[{"name":"applicationId","in":"path","description":"Enter the applicationId.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The response contains the details of the application corresponding to the applicationId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationDTO"}}}}}},"put":{"tags":["Applications"],"description":"Use this method to update the application name, application tags or the contact user name for an existing application by providing the applicationId. \n\nNOTE: This method cannot be used to change the organizationId of an application.\n\nPermissions required: Edit IQ Elements","operationId":"updateApplication","parameters":[{"name":"applicationId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Specify the applicationId, application name and the organizationId under which the application exists. `contactUserName` corresponds to the 'contact' field in the UI and represents the user name. If LDAP is used for authentication, you can use LDAP usernames.`tagId` is the internal identifier for the Application Category that you want to apply to the application. . Use the Application Categories REST API for the available categories and the corresponding tagIds.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationDTO"}}}},"responses":{"200":{"description":"The response contains the updated application name, contact user name and application tags, for the applicationId provided","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationDTO"}}}}}},"delete":{"tags":["Applications"],"description":"Use this method to permanently delete an existing application and all data associated with it. This action cannot be un-done. Before deleting, confirm that the application being deleted does not impact any integrations that could depend on it.\n\nPermissions required: Edit IQ Elements","operationId":"deleteApplication","parameters":[{"name":"applicationId","in":"path","description":"Enter the applicationId to be deleted.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Application deleted successfully"}}}},"/api/v2/applications/organization/{organizationId}":{"get":{"tags":["Applications"],"description":"Use this method to retrieve application details for all applications under the organizationId provided.\n\nPermissions required: View IQ Elements","operationId":"getApplicationsByOrganizationId","parameters":[{"name":"organizationId","in":"path","description":"Enter the organizationId.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The response contains the details of all applications found under the organizationId provided.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiApplicationListDTO"}}}}}}},"/api/v2/applications/{applicationId}/move/organization/{organizationId}":{"post":{"tags":["Applications"],"description":"Use this method to move an application from one organization to another.\n\nPermissions required: Edit IQ Elements","operationId":"moveApplication","parameters":[{"name":"applicationId","in":"path","description":"Enter the applicationId of the application to be moved.","required":true,"schema":{"type":"string"}},{"name":"organizationId","in":"path","description":"Enter the organizationId of the destination organization.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Application moved successfully, with/without warnings. Warnings, if any, will appear in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiMoveApplicationResponseDTOV2"}}}},"409":{"description":"Moving the application failed due to conflicts between the organizations."},"404":{"description":"Moving the application failed because either an application with the provided applicationId or the organizationId for the organization where it is to be moved is not found."}}}},"/api/v2/auditLogs":{"get":{"tags":["Audit Logs"],"description":"Use this method to retrieve the audit events for the specified time period.\n\nPermissions required: Access Audit Log","operationId":"getAuditLogs","parameters":[{"name":"startUtcDate","in":"query","description":"Enter the start UTC date in the format (yyyy-mm-dd).","schema":{"type":"string"}},{"name":"endUtcDate","in":"query","description":"Enter the end UTC date in the format (yyyy-mm-dd).","schema":{"type":"string"}}],"responses":{"200":{"description":"The response text contains lines of audit events in chronologically ascending order.","content":{"text/plain":{}}}}}},"/api/v2/components/remediation/{ownerType}/{ownerId}/bulk":{"post":{"tags":["Components"],"description":"Bulk variant of the component remediation endpoint. Accepts a list of components and returns a per-component result for each. This is intended for callers (such as the ServiceNow AppVR integration) that need remediations for many components against the same owner/stage and would otherwise have to make one call per component. The batch is capped at 200 components; larger requests return 400.","operationId":"getSuggestedRemediationForComponents","parameters":[{"name":"ownerType","in":"path","description":"Possible values: application, organization, repository. ","required":true,"schema":{"pattern":"application|organization|repository","type":"string","enum":["application","organization","repository"]}},{"name":"ownerId","in":"path","description":"Possible values: applicationId, organizationId or repositoryId.","required":true,"schema":{"type":"string"}},{"name":"stageId","in":"query","description":"Enter the stageId to obtain next-non-failing and next-non-failing-with-dependencies remediation types in the response. Possible values are develop, build, stage-release, release and operate.","schema":{"type":"string"}},{"name":"identificationSource","in":"query","description":"Enter the identification source if you want the remediation result based on third-party scan information (non-Sonatype). The identification source can be obtained from the Component Details Page in the UI.","schema":{"type":"string"}},{"name":"scanId","in":"query","description":"Enter the scanId (reportId) if you want the remediation result based on third-party scan information (non-Sonatype).","schema":{"type":"string"}},{"name":"includeParentRemediation","in":"query","description":"Enter true if you want to include parent remediation for transitive dependency in the response based on your application policy scan.","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiBulkComponentRemediationRequestDTO"}}}},"responses":{"200":{"description":"The response returns a list of results, one per input component, in the same order as the input. Each result echoes the input component and contains either a remediation payload (same shape as the single-component endpoint's response) or, for per-component input-validation failures (null entry, missing componentIdentifier/packageUrl, malformed identifier or purl, HDS-unknown component), an error message. All other failures — batch-level input errors (missing components, oversized batch, invalid stageId, invalid scanId for repositories), authorization/license issues, downstream infrastructure failures, and batch-level deadline (HTTP 503) — return the usual error status codes instead of a 200."}}}},"/api/v2/vulnerabilities":{"post":{"tags":["Vulnerability Details"],"description":"Use this method to retrieve bulk details for vulnerabilies using authenticated or non-authenticated requests. A non-authenticated request will retrieve limited details for the vulnerability.\n\nPermissions required: View IQ Elements","operationId":"getSecurityVulnerabilityDetails","requestBody":{"description":"Enter the vulnerability identifiers (CVE ID or Sonatype Vulnerability Identifier) as query parameter","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}},"required":true},"responses":{"200":{"description":"The response contains a list of vulnerability details corresponding to the vulnerabilitity or component identifiers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSecurityVulnerabilityDataDTO"}}}}},"security":[]}},"/api/v2/config/ci/{ownerType}/{ownerId}":{"get":{"tags":["CI Configuration"],"description":"Use this method to retrieve CI integration configuration for the specified owner.\n\nSet the `direct` query parameter to `true` to retrieve only the configuration directly associated with the specified owner. Set it to `false` (default) to retrieve the merged configuration from the organization hierarchy, where configurations from parent organizations are combined with lower levels taking precedence.\n\nThe response includes a `source` map that indicates which owner (organization or application) contributed each configuration field when using merged mode.\n\nPermissions required: View IQ Elements","operationId":"getConfiguration","parameters":[{"name":"ownerType","in":"path","description":"The owner type (application or organization)","required":true,"schema":{"pattern":"application|organization","type":"string","enum":["application","organization"]}},{"name":"ownerId","in":"path","description":"The internal ID of the owner","required":true,"schema":{"type":"string"}},{"name":"direct","in":"query","description":"Set to true to retrieve only direct configuration, false (default) to retrieve merged configuration from hierarchy","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"The response contains:\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCiConfigurationResponseDto"}}}},"404":{"description":"No CI configuration found for the specified owner or its hierarchy."}}},"put":{"tags":["CI Configuration"],"description":"Use this method to create or update CI integration configuration for the specified owner.\n\nThe configuration is stored as a JSON object to support various CI systems (GitHub Actions, GitLab CI, etc.). String values must be non-empty.\n\nPermissions required: Edit IQ Elements","operationId":"setConfiguration","parameters":[{"name":"ownerType","in":"path","description":"The owner type (application or organization)","required":true,"schema":{"pattern":"application|organization","type":"string","enum":["application","organization"]}},{"name":"ownerId","in":"path","description":"The internal ID of the owner","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Provide the CI integration configuration as a JSON object. The structure supports different CI systems.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCiConfigurationDto"}}}},"responses":{"200":{"description":"CI configuration was saved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiCiConfigurationDto"}}}},"400":{"description":"Invalid configuration provided (e.g., empty strings)."}}},"delete":{"tags":["CI Configuration"],"description":"Use this method to delete CI integration configuration for the specified owner.\n\nPermissions required: Edit IQ Elements","operationId":"deleteConfiguration","parameters":[{"name":"ownerType","in":"path","description":"The owner type (application or organization)","required":true,"schema":{"pattern":"application|organization","type":"string","enum":["application","organization"]}},{"name":"ownerId","in":"path","description":"The internal ID of the owner","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"CI configuration was deleted successfully."},"404":{"description":"CI configuration not found for the specified owner."}}}},"/api/v2/components/details":{"post":{"tags":["Components"],"description":"Use this method to retrieve data related to a component.","operationId":"getComponentDetails","requestBody":{"description":"You can retrieve component data in any one of the 3 ways via:\n1. Component identifier\n2. Package URL\n3. Hash","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiComponentDetailsRequestDTOV2"}}},"required":true},"responses":{"200":{"description":"The response contains a detailed description of the component. The hash value returned here is truncated and not intended to be used as a checksum. It can be used as an identifier to pass to other REST API calls.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiComponentDetailsResultDTOV2"}}}}}}},"/api/v2/components/{componentHash}/labels/{labelName}/{ownerType}s/{internalOwnerId}":{"post":{"tags":["Components"],"description":"Use this method to assign an existing label to a component.","operationId":"setComponentLabel","parameters":[{"name":"ownerType","in":"path","description":"Possible values: application or organization","required":true,"schema":{"pattern":"application|organization","type":"string","enum":["application","organization"]}},{"name":"internalOwnerId","in":"path","description":"Possible values : applicationId or organizationId","required":true,"schema":{"type":"string"}},{"name":"componentHash","in":"path","description":"Enter the SHA1 hash of the component.","required":true,"schema":{"type":"string"}},{"name":"labelName","in":"path","description":"Enter the label name to assign to this component.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Component label assigned successfully."}}},"delete":{"tags":["Components"],"description":"Use this method to un-assign a label from a component.","operationId":"deleteComponentLabel","parameters":[{"name":"ownerType","in":"path","description":"Possible values: application or organization","required":true,"schema":{"pattern":"application|organization","type":"string","enum":["application","organization"]}},{"name":"internalOwnerId","in":"path","description":"Possible values : applicationId or organizationId","required":true,"schema":{"type":"string"}},{"name":"componentHash","in":"path","description":"Enter the SHA1 hash of the component.","required":true,"schema":{"type":"string"}},{"name":"labelName","in":"path","description":"Enter the label name to un-assign from this component.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Label un-assigned from component successfully."}}}},"/api/v2/repositories/quarantine/{quarantineId}/release":{"post":{"tags":["Repositories"],"description":"Use this method to release a component from quarantine by providing the `quarantineId`.\n\nUse the GET method of the Reports REST API to retrieve the `quarantineId` for the quarantined component.\n\nPermissions required: Edit IQ Elements","operationId":"releaseQuarantineWithoutReEval","parameters":[{"name":"quarantineId","in":"path","description":"Enter the component `quarantineId`.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Enter a waiver comment for releasing the component from quarantine.","content":{"text/plain":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"The response contains: