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 Application Report Data API

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

Sonatype Application Report Data 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 Application Report Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and 2 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 32 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}/.

5 operations 5 paths 32 schemas 5 GET

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 Application Report Data 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 5

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

Application Report Data 5

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/policyViolations/diff
By configuring Lifecycle with SCM, policy evaluations can be linked to the Git commit hash. Use this method to compare the violations between policy evaluations for 2 commits, by providing the linked…
getPolicyViolationDiff 6 params → 200400404
GET
/api/v2/applications/{applicationPublicId}/reports/{scanId}
This is an older version of the endpoint. This call will now be redirected to /api/v2/applications/{applicationPublicId}/reports/{scanId}/raw.
getData 2 params → 307
GET
/api/v2/applications/{applicationPublicId}/reports/{scanId}/dependencyTree
Use this method to retrieve the dependencies related to the component identified at the time of application evaluation. This is currently available only for Java (Maven) and NPM applications. Permiss…
getDependencyTree 2 params → 200400404
GET
/api/v2/applications/{applicationPublicId}/reports/{scanId}/policy
Use this method to retrieve the policy violation data generated as a result of an application evaluation, for each component identified in the application evaluation./n/nPermissions required: View IQ…
getPolicyViolations_1 3 params → 200
GET
/api/v2/applications/{applicationPublicId}/reports/{scanId}/raw
Use this method to retrieve the 'raw' data generated as a result of an application evaluation. 'raw' data includes: the components identified in the application, and the licenses and vulnerabilities…
getRawData 2 params → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are ApiReportComponentDTOV2 (17 properties), ApiReportPolicyViolationDTOV2 (14 properties), ApiReportComponentPolicyViolationsDTOV2 (12 properties), ApiPolicyViolationForDiffDTO (10 properties). Each schema is shown below with its type and property counts.

TriggerReference
object
2 properties
ApiLicenseThreatDTOV2
object
3 properties
ApiComponentIdentifierDTOV2
object
2 properties
ApiDependencyTreeNodeDTO
object
4 properties
ApiGlobalInformationDTOV2
object
1 property
ApiReportPolicyDataDTOV2
object
7 properties
AttachmentText
object
3 properties
ApiApplicationEvaluationCommitDTO
object
4 properties
ApiSecurityIssueAnalysisDTO
object
4 properties
ApiLicenseDTO
object
2 properties
InnerSourceData
object
3 properties
ApiReportComponentPolicyViolationsDTOV2
object
12 properties
ApiPolicyViolationForDiffDTO
object
10 properties
ApiReportConstraintViolationDTOV2
object
3 properties
ApiConstraintViolationReasonDTO
object
2 properties
ApiDependencyTreeResponseDTO
object
1 property
ApiMatchStateSummaryDTOV2
object
2 properties
ApiReportPolicyViolationDTOV2
object
14 properties
ApiDependencyDataDTO
object
4 properties
ApiConstraintViolationDTO
object
3 properties
ApiApplicationBaseDTO
object
5 properties
ApiApplicationDTO
object
6 properties
ApiApplicationTagDTO
object
3 properties
ApiReportComponentDTOV2
object
17 properties
ApiSecurityIssueDTO
object
10 properties
ApiSecurityDataDTO
object
1 property
ApiReportConstraintConditionDTOV2
object
2 properties
ApiReportRawDataDTOV2
object
3 properties
ApiLicenseDataDTOV2
object
6 properties
ApiPolicyViolationDiffDTO
object
7 properties
ApiComponentDTOV2
object
8 properties
Swid
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-application-report-data-api-openapi.yml Raw ↑

Other APIs Sonatype publishes across the network.

Sonatype Advanced Search API
Sonatype Application Categories 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
Sonatype Composite Source Control API
Where this information came from

This is an independent, third-party profile of Sonatype Application Report Data 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.