IQ API Reference

Use the Swagger API reference for Sonatype IQ Server-powered solutions, including Sonatype Lifecycle, Sonatype Developer, Sonatype SBOM Manager, and Sonatype Firewall.

Sonatype Lifecycle Public REST API 1.205.0-03 OAS 3.0

https://sonatype.github.io/sonatype-documentation/api/iq/latest/iq-api.json

Advanced Search

Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.

• POST /api/v2/search/advanced/index
• GET /api/v2/search/advanced/export/csv
• GET /api/v2/search/advanced

Application Categories

Use the Application Categories REST API to manage the application categories or tags assigned to the applications in an organization.

• GET /api/v2/applicationCategories/organization/{organizationId}
• PUT /api/v2/applicationCategories/organization/{organizationId}
• POST /api/v2/applicationCategories/organization/{organizationId}
• DELETE /api/v2/applicationCategories/organization/{organizationId}/{tagId}
• GET /api/v2/applicationCategories/organization/{organizationId}/applicable
• GET /api/v2/applicationCategories/application/{applicationPublicId}/applicable
• GET /api/v2/applicationCategories/application/{applicationPublicId}
• GET /api/v2/applicationCategories/organization/{organizationId}/policy
• GET /api/v2/applicationCategories/organization/{organizationId}/applied
• GET /api/v2/applicationCategories/application

Application Report Data

Use this REST API to retrieve the data from an application composition report, that is generated after an evaluation.

• GET /api/v2/applications/{applicationPublicId}/reports/{scanId}
• GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree
• GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/metadata
• GET /api/v2/applications/{applicationPublicId}/reports/policyViolations/diff
• GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/policy
• GET /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw

Applications

Use this REST API to manage applications. In addition to the primary functions of create, update and delete, you can also move applications from one organization to other.

• GET /api/v2/applications
• POST /api/v2/applications
• POST /api/v2/applications/{sourceApplicationId}/clone
• GET /api/v2/applications/{applicationId}
• PUT /api/v2/applications/{applicationId}
• DELETE /api/v2/applications/{applicationId}
• GET /api/v2/applications/organization/{organizationId}
• POST /api/v2/applications/{applicationId}/move/organization/{organizationId}

Audit Logs

Use this REST API to access the IQ Server audit logs.

• GET /api/v2/auditLogs

CI Configuration

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.

• GET /api/v2/config/ci/{ownerType}/{ownerId}
• PUT /api/v2/config/ci/{ownerType}/{ownerId}
• DELETE /api/v2/config/ci/{ownerType}/{ownerId}

Consumption

• GET /api/v2/consumption/export
• GET /api/v2/consumption/daily-history
• GET /api/v2/consumption/history
• GET /api/v2/consumption/history/breakdown
• GET /api/v2/consumption/history/by-source
• GET /api/v2/consumption/history/by-stage
• GET /api/v2/consumption/summary
• GET /api/v2/consumption/top-apps

Security Vulnerability Overrides

Use this REST API to retrieve security vulnerabilities that have been overridden.

• GET /api/v2/securityOverrides

Reports

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.

• GET /api/v2/reports/components/waivers
• POST /api/v2/reports/metrics
• GET /api/v2/reports/applications
• GET /api/v2/reports/applications/{applicationId}
• GET /api/v2/reports/applications/{applicationId}/history
• GET /api/v2/reports/waivers/stale