How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Sonatype Reports API

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.

Sonatype Reports API is one of 58 APIs that Sonatype publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 2 JSON Schemas.

This API exposes 7 operations across 7 paths, and defines 43 schemas. It is described by OpenAPI 3.2.0, at version 1.201.0-02.

Requests are made against the base URL https://{iq-server-host}/.

7 operations 7 paths 43 schemas 6 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.201.0-02
Base URL
https://{iq-server-host}/
Authentication
HTTP Basic, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Sonatype Reports API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (BasicAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 6 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 7

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 addition…

GET
/api/v2/reports/applications
Use this method to view all application reports for applications to which you have access. Permissions required: View IQ Elements
getAll_1 → 200
GET
/api/v2/reports/applications/{applicationId}
Use this method to retrieve the application reports for the specified application Id. You can view application reports only for applications to which you have access. Permissions required: View IQ El…
getByApplicationId 1 param → 200
GET
/api/v2/reports/applications/{applicationId}/history
Use this method to retrieve previous application scan reports (100 max.) for the specified application. You can view application reports only for applications to which you have access. Permissions re…
getReportHistoryForApplication 3 params → 200400404
GET
/api/v2/reports/components/quarantined
Use this method to retrieve all repository components that are quarantined. The response contains violation details and the quarantine Id of the component. Use the quarantine Id, to release the compo…
getComponentsInQuarantine → 200
GET
/api/v2/reports/components/waivers
Use this method to retrieve existing policy waivers by components. For an up-to-date response, ensure that all application and repository reports are current and contain the most recent re-evaluation…
getComponentsWithWaivers 1 param → 200
POST
/api/v2/reports/metrics
Use this method to retrieve metrics data such as policy evaluation metrics, violation and remediation metrics aggregated monthly or weekly. Permissions required: View IQ Elements
getMetrics body → 200
GET
/api/v2/reports/waivers/stale
Stale waivers pose a risk because they could be applied unintentionally. Use this method to retrieve stale waivers to eliminate this risk for future application evaluations. Permissions required: Vie…
getStaleWaivers → 200409

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are ApiPolicyWaiverDTO (29 properties), ApiReportResultsDTO (18 properties), PolicyEvaluationResult (16 properties), ApiStaleWaiverDTO (15 properties). Each schema is shown below with its type and property counts.

TriggerReference
object
2 properties
ApiComponentIdentifierDTOV2
object
2 properties
PolicyFact
object
5 properties
ApiConstraintFactDTO
object
3 properties
Action
object
3 properties
ApiWaivedPolicyViolationDTO
object
10 properties
ApiStaleApplicationEvaluationDTO
object
2 properties
ApiComponentWaiversDTO
object
2 properties
ApiComponentPolicyViolationDTO
object
2 properties
ApiMetricsReportingDTOV2
object
6 properties
ApiStaleEvaluationStageDTO
object
2 properties
ApiPolicyViolationDTOV2
object
9 properties
ApiRepositoryComponentsInQuarantineDTO
object
2 properties
ApiReportResultsDTO
object
18 properties
ApiConditionFactReasonDTO
object
1 property
ComponentIdentifier
object
2 properties
ApiConstraintViolationReasonDTO
object
2 properties
ConditionFact
object
6 properties
ApiStaleWaiverDTO
object
15 properties
ApiStaleEvaluationsDTO
object
2 properties
ApiRepositoryComponentDTO
object
10 properties
ApiComponentsInQuarantineDTO
object
1 property
ConstraintFact
object
4 properties
ApiRepositoryComponentPolicyViolationDTO
object
3 properties
ApiApplicationWaiverDTO
object
2 properties
PolicyAlert
object
2 properties
ApiRepositoryWaiverDTO
object
2 properties
ComponentDisplayNamePart
object
2 properties
ApiConstraintViolationDTO
object
3 properties
ApiRepositoryDTO
object
8 properties
ApiStaleRepositoryEvaluationDTO
object
2 properties
ApiApplicationReportDTOV2
object
8 properties
ApiApplicationBaseDTO
object
5 properties
PolicyEvaluationResult
object
16 properties
ApiPolicyViolationStageDTO
object
2 properties
ApiMetricsReportingAggregationDTOV2
object
10 properties
ApiStaleWaiversResponseDTO
object
1 property
ApiMetricsReportingQueryDTOV2
object
5 properties
ApiPolicyWaiverDTO
object
29 properties
ComponentDisplayName
object
2 properties
ApiReportHistoryDTO
object
2 properties
ApiComponentDTOV2
object
8 properties
ComponentFact
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-reports-api-openapi.yml Raw ↑

Other APIs Sonatype publishes across the network.

Sonatype Advanced Search API
Sonatype Application Categories API
Sonatype Application Report Data API
Sonatype Applications API
Sonatype Audit Logs API
Sonatype Auto Policy Waiver Exclusions API
Sonatype Auto Policy Waivers API
Sonatype CI Configuration API
Sonatype Claim Components API
Sonatype Component Labels API
Sonatype Component Search API
Sonatype Components API
Where this information came from

This is an independent, third-party profile of Sonatype Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.