Sonatype website screenshot

Sonatype

Sonatype provides software supply chain management solutions including Sonatype Lifecycle (IQ Server), Sonatype Repository Firewall, SBOM Manager, and Nexus Repository. The Lifecycle Public REST API provides 188 endpoints for application portfolio management, policy enforcement, vulnerability reporting, component analysis, SBOM generation, source control integration, and software composition analysis across the SDLC.

Sonatype publishes 58 APIs on the APIs.io network, including Advanced Search API, Application Categories API, Application Report Data API, and 55 more. Tagged areas include Software Supply Chain, Security, Vulnerability Management, SBOM, and Software Composition Analysis.

The Sonatype catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Sonatype’s developer surface includes authentication, developer portal, documentation, GitHub presence, engineering blog, changelog, support, and 5 more developer resources.

🌐 Visit website 📡 Source on GitHub
52.9/100 developing ▬ flat Agent 34/100 agent aware Full breakdown ↓
scored 2026-08-05 · rubric v0.9.1
AccessFreemiumSelf serve⚡ Free to try
58 APIs
Software Supply ChainSecurityVulnerability ManagementSBOMSoftware Composition AnalysisDevSecOps

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-08-05 · rubric v0.9.1
Composite quality — 52.9/100 · developing
Contract Quality 15.3 / 25
Developer Ergonomics 7.0 / 20
Commercial Clarity 10.0 / 20
Operational Transparency 6.8 / 13
Governance 7.0 / 12
Discoverability 6.9 / 10
Agent readiness — 34/100 · agent aware
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/sonatype: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 58

Individual APIs this provider publishes, each with its own machine-readable definition.

Sonatype Advanced Search API

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

Sonatype Application Categories API

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

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 Applications API

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.

Sonatype Audit Logs API

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

Sonatype Auto Policy Waiver Exclusions API

Use this REST API to create and delete auto policy waiver exclusions.

Sonatype Auto Policy Waivers API

Use this REST API to create, modify and retrieve auto policy waivers.

Sonatype CI Configuration API

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 lowe...

Sonatype Claim Components API

Use this REST API to manage components that are developed in-house and are not open-source. Claiming the component stores the identity information for the component hash and avo...

Sonatype Component Labels API

Use this REST API to manage component labels for applications, organizations and repositories. Component Labels can be used as attributes of a component at the time of creating ...

Sonatype Component Search API

Use this REST API to search for components in application evaluation reports.

Sonatype Components API

Use this REST API to retrieve a component's security vulnerability data, license data, age and popularity.

Sonatype Composite Source Control API

Use this REST API to access the composite source control management configuration (SCM) for an application or organization. Composite source control configuration is defined as ...

Sonatype Composite Source Control Validator API

Use this REST API to validate the composite source control management (SCM) configuration. Composite source control configuration is defined as the configuration that is inherit...

Sonatype Config Crowd API

Use this REST API to manage the configuration of an existing Atlassian Crowd Server that is being used to authenticate users for IQ Server.

Sonatype Config Jira API

Use this REST API to manage Jira configurations to receive notifications from Lifecycle. It is supported for Jira Cloud, Jira Server, and Jira Data Center.

Sonatype Config Mail API

Use this REST API to manage the configuration of an SMTP server, to receive email notifications.

Sonatype Config OIDC API

Use this REST API to manage the OIDC configuration for IQ Server.

Sonatype Config Proxy Server API

Use this REST API to manage the configuration of IQ Server with an existing HTTP proxy server.

Sonatype Config Reverse Proxy Authentication API

Use this REST API to manage the configuration of a reverse proxy server.

Sonatype Config SAML API

Use this REST API to manage the SAML configuration for IQ Server.

Sonatype Config Source Control API

Use this REST API to manage the configuration of IQ Server with your Source Control Management (SCM) system (e.g. GitHub).

Sonatype Config Zscaler API

Use this REST API to manage the configuration of a Zscaler service.

Sonatype Configuration API

Use this REST API to configure the IQ Server system properties. We strongly recommend using this REST API instead of config.yml for versions 142 and higher.

Sonatype Configure Artifactory Connection API

Use this REST API to manage the configuration of Firewall for JFrog Artifactory.

Sonatype CPE Matching Configuration API

Use the CPE Matching Configuration REST API to add/set/remove cpe matching configuration to organizations and applications

Sonatype CycloneDX API

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.

Sonatype Data Retention Policies API

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...

Sonatype Developer Priorities API

Use this REST API to export Sonatype Developer component priorities data, including security reachability data.

Sonatype Endpoints API

This REST API returns the OpenAPI documentation for the specified IQ Server REST API.

Sonatype Feature Configuration API

Use this REST API to enable/disable the IQ Server features.

Sonatype Firewall API

Use this REST API for managing and monitoring firewall features, including metrics, repository management, quarantine operations, and namespace confusion prevention.

Sonatype GitHub App Configuration API

GitHub App configuration operations

Sonatype License Legal Metadata Report API

Use this REST API to retrieve license legal metadata in raw or HTML format.

Sonatype License Legal Metadata Template API

Use this REST API to manage and customize templates for the license legal metadata generated in HTML format.

Sonatype License Overrides API

Use this REST API to manage license overrides for components in your applicationsorganizations and repositories.

Sonatype Organizations API

Use this REST API to create new organizations, retrieve, edit or delete existing organizations.

Sonatype Policies API

Use this REST API to retrieve details on all existing policies in your instance of Lifecycle.

Sonatype Policy Evaluation API

Use this REST API to perform an application policy evaluation. Policy evaluations are executed asynchronously.

This is a 2-step process that involves: 1. Requesting a policy e...

Sonatype Policy Violation Details API

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 ...

Sonatype Policy Waiver Reasons API

Use this rest API to fetch available policy waiver reasons

Sonatype Policy Waiver Requests API

Use this REST API to manage policy waiver requests.

Sonatype Policy Waivers API

Use this REST API to create and retrieve policy waivers.

Sonatype Product License API

Use this REST API to manage a product license.

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 additi...

Sonatype Repositories API

Use this REST API to manage quarantined components.

Sonatype Role Memberships API

Use this REST API to manage authorizations for users or user groups. You can view existing role assignments and grant or revoke user authorization on organizations, applications...

Sonatype Roles API

Roles provide sets of permissions that grant access to the functionality in the user interface, through integrations, and when using REST APIs. Permissions are granted by assign...

Sonatype Security Vulnerability Overrides API

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

Sonatype Solutions API

The Solutions API from Sonatype — 1 operation(s) for solutions.

Sonatype Source Control API

Use this REST API to:

  • Create, update and delete source control management (SCM) configuration for the root organization, sub-organizations and applications.
  • Autom...

Sonatype Source Control Metrics API

Use this REST API to view the response times of a source control evaluation.

Sonatype SPDX API

Use this REST API to generate SPDX SBOMs in XML or JSON formats.

Sonatype Third-Party Analysis API

Use this REST API to scan SBOMs for your applications.

Sonatype User Token Configuration API

Use this REST API to manage user token expiration configuration.

Sonatype User Tokens API

Use this REST API to manage user tokens.

Sonatype Users API

Use this REST API to manage users.

Sonatype Vulnerability Details API

Use this REST API to retrieve vulnerability details.

Scroll for all 58

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Sonatype Lifecycle Public REST API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Sonatype Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Sonatype Rate Limits

5 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Sonatype Finops

FINOPS

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Sonatype Context

2 classes · 12 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Sonatype API Rules

5 rules · 3 warnings 2 info

SPECTRAL

Sonatype API Rules

8 rules · 2 errors 6 warnings

SPECTRAL

JSON Schema 2

Standalone JSON Schema definitions for this provider's data models.

Sonatype Lifecycle Application

6 properties

JSON SCHEMA

Sonatype Policy Violation

8 properties

JSON SCHEMA

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Sonatype Application Structure

0 properties

JSON STRUCTURE

Examples 2

Example request and response payloads for these APIs.

Sonatype List Applications Example

3 fields

EXAMPLE

Sonatype Search Component Example

3 fields

EXAMPLE

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Sonatype Authentication

http · 2 schemes

SECURITY

Sonatype Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Sonatype Agentic Access

265 operations · 134 acting · 15 human-in-the-loop

265 operations · 134 acting

AGENTIC

Resources

Get Started 1

Portal, sign-up, and the first successful call

Portal
Portal

Documentation 1

Reference material describing how the API behaves

Documentation
Documentation

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess

Build 1

SDKs, sample code, and the tooling you integrate with

GitHub
GitHub

Access & Security 2

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication

Operate 2

Status, limits, changes, and where to get help

ChangeLog
ChangeLog
 Support
Support

Commercial 1

Pricing, plans, and the legal terms of use

Pricing
Pricing

Company 3

The organization behind the API

LinkedIn
LinkedIn
 Website
Website
 Blog
Blog

Source (apis.yml)

apis.yml Raw ↑ 
aid: sonatype
name: Sonatype
description: Sonatype provides software supply chain management solutions including Sonatype Lifecycle (IQ Server), Sonatype
  Repository Firewall, SBOM Manager, and Nexus Repository. The Lifecycle Public REST API provides 188 endpoints for application
  portfolio management, policy enforcement, vulnerability reporting, component analysis, SBOM generation, source control integration,
  and software composition analysis across the SDLC.
type: Index
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
position: Consumer
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/sonatype.png
tags:
- Software Supply Chain
- Security
- Vulnerability Management
- SBOM
- Software Composition Analysis
- DevSecOps
url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/apis.yml
created: '2025-02-12'
modified: '2026-05-19'
specificationVersion: '0.19'
apis:
- aid: sonatype:sonatype-advanced-search-api
  name: Sonatype Advanced Search API
  description: Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Advanced Search
  properties:
  - type: OpenAPI
    url: openapi/sonatype-advanced-search-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-application-categories-api
  name: Sonatype Application Categories API
  description: Use the Application Categories REST API to manage the application categories or tags assigned to the applications
    in an organization.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Application Categories
  properties:
  - type: OpenAPI
    url: openapi/sonatype-application-categories-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-application-report-data-api
  name: Sonatype Application Report Data API
  description: Use this REST API to retrieve the data from an application composition report, that is generated after an evaluation.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Application Report Data
  properties:
  - type: OpenAPI
    url: openapi/sonatype-application-report-data-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-applications-api
  name: Sonatype Applications API
  description: '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.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Applications
  properties:
  - type: OpenAPI
    url: openapi/sonatype-applications-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-audit-logs-api
  name: Sonatype Audit Logs API
  description: Use this REST API to access the IQ Server audit logs.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Audit Logs
  properties:
  - type: OpenAPI
    url: openapi/sonatype-audit-logs-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-auto-policy-waiver-exclusions-api
  name: Sonatype Auto Policy Waiver Exclusions API
  description: Use this REST API to create and delete auto policy waiver exclusions.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Auto Policy Waiver Exclusions
  properties:
  - type: OpenAPI
    url: openapi/sonatype-auto-policy-waiver-exclusions-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-auto-policy-waivers-api
  name: Sonatype Auto Policy Waivers API
  description: Use this REST API to create, modify and retrieve auto policy waivers.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Auto Policy Waivers
  properties:
  - type: OpenAPI
    url: openapi/sonatype-auto-policy-waivers-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-ci-configuration-api
  name: Sonatype CI Configuration API
  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.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - CI Configuration
  properties:
  - type: OpenAPI
    url: openapi/sonatype-ci-configuration-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-claim-components-api
  name: Sonatype Claim Components API
  description: 'Use this REST API to manage components that are developed in-house and are not open-source.


    Claiming the component stores the identity information for the component hash and avoids triggering the Component-Unknown
    policy.


    Components will have a match state as `Exact` and Identification Source as `Manual`,

    for subsequent scans or evaluations.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Claim Components
  properties:
  - type: OpenAPI
    url: openapi/sonatype-claim-components-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-component-labels-api
  name: Sonatype Component Labels API
  description: 'Use this REST API to manage component labels for applications, organizations and repositories.


    Component 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.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Component Labels
  properties:
  - type: OpenAPI
    url: openapi/sonatype-component-labels-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-component-search-api
  name: Sonatype Component Search API
  description: Use this REST API to search for components in application evaluation reports.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Component Search
  properties:
  - type: OpenAPI
    url: openapi/sonatype-component-search-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-components-api
  name: Sonatype Components API
  description: Use this REST API to retrieve a component's security vulnerability data, license data, age and popularity.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Components
  properties:
  - type: OpenAPI
    url: openapi/sonatype-components-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-composite-source-control-api
  name: Sonatype Composite Source Control API
  description: 'Use this REST API to access the composite source control management configuration (SCM) for an application
    or organization.


    Composite source control configuration is defined as the configuration that is inherited from the parent organization
    or is directly assigned.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Composite Source Control
  properties:
  - type: OpenAPI
    url: openapi/sonatype-composite-source-control-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-composite-source-control-validator-api
  name: Sonatype Composite Source Control Validator API
  description: 'Use this REST API to validate the composite source control management (SCM) configuration.


    Composite source control configuration is defined as the configuration that is inherited from the parent or is directly
    assigned.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Composite Source Control Validator
  properties:
  - type: OpenAPI
    url: openapi/sonatype-composite-source-control-validator-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-crowd-api
  name: Sonatype Config Crowd API
  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.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Crowd
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-crowd-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-jira-api
  name: Sonatype Config Jira API
  description: 'Use this REST API to manage Jira configurations to receive notifications from Lifecycle.


    It is supported for Jira Cloud, Jira Server, and Jira Data Center.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Jira
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-jira-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-mail-api
  name: Sonatype Config Mail API
  description: Use this REST API to manage the configuration of an SMTP server, to receive email notifications.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Mail
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-mail-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-oidc-api
  name: Sonatype Config OIDC API
  description: Use this REST API to manage the OIDC configuration for IQ Server.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config OIDC
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-oidc-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-proxy-server-api
  name: Sonatype Config Proxy Server API
  description: Use this REST API to manage the configuration of IQ Server with an existing HTTP proxy server.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Proxy Server
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-proxy-server-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-reverse-proxy-authentication-api
  name: Sonatype Config Reverse Proxy Authentication API
  description: Use this REST API to manage the configuration of a reverse proxy server.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Reverse Proxy Authentication
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-reverse-proxy-authentication-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-saml-api
  name: Sonatype Config SAML API
  description: Use this REST API to manage the SAML configuration for IQ Server.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config SAML
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-saml-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-source-control-api
  name: Sonatype Config Source Control API
  description: Use this REST API to manage the configuration of IQ Server with your Source Control Management (SCM) system
    (e.g. GitHub).
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Source Control
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-source-control-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-config-zscaler-api
  name: Sonatype Config Zscaler API
  description: Use this REST API to manage the configuration of a Zscaler service.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Config Zscaler
  properties:
  - type: OpenAPI
    url: openapi/sonatype-config-zscaler-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-configuration-api
  name: Sonatype Configuration API
  description: 'Use this REST API to configure the IQ Server system properties.


    We strongly recommend using this REST API instead of config.yml for versions 142 and higher.'
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Configuration
  properties:
  - type: OpenAPI
    url: openapi/sonatype-configuration-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-configure-artifactory-connection-api
  name: Sonatype Configure Artifactory Connection API
  description: Use this REST API to manage the configuration of Firewall for JFrog Artifactory.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Configure Artifactory Connection
  properties:
  - type: OpenAPI
    url: openapi/sonatype-configure-artifactory-connection-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-cpe-matching-configuration-api
  name: Sonatype CPE Matching Configuration API
  description: Use the CPE Matching Configuration REST API to add/set/remove cpe matching configuration to organizations and
    applications
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - CPE Matching Configuration
  properties:
  - type: OpenAPI
    url: openapi/sonatype-cpe-matching-configuration-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-cyclonedx-api
  name: Sonatype CycloneDX API
  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.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - CycloneDX
  properties:
  - type: OpenAPI
    url: openapi/sonatype-cyclonedx-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-data-retention-policies-api
  name: Sonatype Data Retention Policies API
  description: Set policies for automatic purging of obsolete application and Success Metrics reports. <p>Note that IQ Server
    has a preset limit of purging 5000 reports in one execution of its report purging job.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Data Retention Policies
  properties:
  - type: OpenAPI
    url: openapi/sonatype-data-retention-policies-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-developer-priorities-api
  name: Sonatype Developer Priorities API
  description: Use this REST API to export Sonatype Developer component priorities data, including security reachability data.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Developer Priorities
  properties:
  - type: OpenAPI
    url: openapi/sonatype-developer-priorities-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-endpoints-api
  name: Sonatype Endpoints API
  description: This REST API returns the OpenAPI documentation for the specified IQ Server REST API.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Endpoints
  properties:
  - type: OpenAPI
    url: openapi/sonatype-endpoints-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-feature-configuration-api
  name: Sonatype Feature Configuration API
  description: Use this REST API to enable/disable the IQ Server features.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Feature Configuration
  properties:
  - type: OpenAPI
    url: openapi/sonatype-feature-configuration-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-firewall-api
  name: Sonatype Firewall API
  description: Use this REST API for managing and monitoring firewall features, including metrics, repository management,
    quarantine operations, and namespace confusion prevention.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - Firewall
  properties:
  - type: OpenAPI
    url: openapi/sonatype-firewall-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-github-app-configuration-api
  name: Sonatype GitHub App Configuration API
  description: GitHub App configuration operations
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - GitHub App Configuration
  properties:
  - type: OpenAPI
    url: openapi/sonatype-github-app-configuration-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-license-legal-metadata-report-api
  name: Sonatype License Legal Metadata Report API
  description: Use this REST API to retrieve license legal metadata in raw or HTML format.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - License Legal Metadata Report
  properties:
  - type: OpenAPI
    url: openapi/sonatype-license-legal-metadata-report-api-openapi.yml
  - type: Documentation
    url: https://help.sonatype.com/en/iq-api-reference.html
  - type: Reference
    url: https://help.sonatype.com/en/rest-apis.html
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
  - type: JSONSchema
    url: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json
- aid: sonatype:sonatype-license-legal-metadata-template-api
  name: Sonatype License Legal Metadata Template API
  description: Use this REST API to manage and customize templates for the license legal metadata generated in HTML format.
  humanURL: https://help.sonatype.com/en/iq-api-reference.html
  baseURL: https://{iq-server-host}/
  tags:
  - License Legal Metadata Template
  properties:
  -

# --- truncated at 32 KB (53 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/apis.yml