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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sonatype

Sonatype Firewall API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

28 operations 22 paths 37 schemas 3 DELETE16 GET7 POST2 PUT

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 Firewall 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 28

Across 22 paths, the API surfaces 28 operations — 3 DELETE, 16 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Firewall 28

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

GET
/api/v2/firewall/components/autoReleasedFromQuarantine
Use this method to retrieve the details of components that are auto-released from quarantine. Permissions required: View IQ Elements
getUnquarantineList 6 params → 200
GET
/api/v2/firewall/components/quarantined
Use this method to request a list of quarantined components. Permissions required: View IQ Elements
getQuarantineList 8 params → 200
POST
/api/v2/firewall/components/{repositoryManagerId}/{repositoryId}/evaluate
Use this method to evaluate components (max. 100). Hash Requirements by Format Type: Coordinate-Based Formats (hash NOT required when using packageUrl): - golang, conan, cargo, cocoapods, cran, conda…
evaluateComponents_1 2 params body → 200
GET
/api/v2/firewall/connection/verify
Use this method to verify that the authenticated user has required permissions for firewall operations and retrieve accessible applications. Permissions required: Evaluate Individual Components
verifyConnectionAndGetApplications → 200401403
GET
/api/v2/firewall/container-image/policyViolations/quarantined
Use this method to find all container images currently in quarantine. Permissions required: Read
getContainerImagesInQuarantine 2 params → 200
GET
/api/v2/firewall/container-image/policyWaiver
Use this method to get all policy waivers for container images. Permissions required: Waive Policy Violations
getWaivers 2 params → 200
DELETE
/api/v2/firewall/container-image/{containerImageId}/policyWaiver
Use this method to delete a container waiver, specified by the containerImageId. Permissions required: Waive Policy Violations
deleteContainerImagePolicyWaiver 1 param → 200
POST
/api/v2/firewall/container-image/{containerImageId}/policyWaiver
Use this method to create a waiver for all policy violations of a container Image. Permissions required: Waive Policy Violations
addWaiver 1 param body → 204
GET
/api/v2/firewall/metrics/embedded
Use this method to retrieve firewall dashboard metrics. Permissions required: View IQ Elements
getFirewallMetrics → 200
DELETE
/api/v2/firewall/namespace_confusion/{format}
Removes proprietary component namespaces for the specified format. Permissions required: Evaluate Individual Components
removeProprietaryComponentNames 1 param → 204
POST
/api/v2/firewall/namespace_confusion/{format}
Adds a list of proprietary component namespaces for the specified format to prevent namespace confusion attacks. Permissions required: Evaluate Individual Components
addProprietaryComponentNames 1 param body → 204
GET
/api/v2/firewall/quarantine/summary
Use this method to request a summary of quarantined components. Permissions required: View IQ Elements
getQuarantineSummary → 200
GET
/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess
Use this method to determine if the quarantined component(s) details can be accessed anonymously. Permissions required: None
getQuarantinedComponentViewAnonymousAccess → 200
PUT
/api/v2/firewall/quarantinedComponentView/configuration/anonymousAccess/{enabled}
Use this method to enable/disable anonymous access to view the quarantined components. Permissions required: Edit IQ Elements
setQuarantinedComponentViewAnonymousAccess 1 param → 204
GET
/api/v2/firewall/releaseQuarantine/configuration
Use this method to retrieve the configuration settings for auto-release from quarantine for repositories. Permissions required: View IQ Elements
getFirewallAutoUnquarantineConfig → 200
PUT
/api/v2/firewall/releaseQuarantine/configuration
Use this method to set the configurations for auto-release from quarantine for a list of repositories. Permissions required: Edit IQ Elements
setFirewallAutoUnquarantineConfig body → 200
GET
/api/v2/firewall/releaseQuarantine/summary
Use this method to track how many components have been automatically released from quarantine over different time periods. Permissions required: View IQ Elements
getFirewallUnquarantineSummary → 200
POST
/api/v2/firewall/repositories/cascade-reevaluate/componentHash/{componentHash}
Initiate cascade re-evaluation for a component across repository hierarchies. This operation asynchronously re-evaluates the specified component across all repositories where the component exists. Th…
initiateCascadeReevaluation 1 param → 200403
GET
/api/v2/firewall/repositories/cascade-reevaluate/status/{requestId}
Get the status of a cascade re-evaluation request. Returns the current progress of a cascade re-evaluation operation including the list of components that have been evaluated and those still pending.…
getCascadeStatus 1 param → 200403404
GET
/api/v2/firewall/repositories/configuration/{repositoryManagerId}
Use this method to retrieve the configuration details of an existing repository manager. Permissions required: View IQ Elements
getConfiguredRepositories 2 params → 200
POST
/api/v2/firewall/repositories/configuration/{repositoryManagerId}
Use this method to update the repositories for an existing repository manager. Permissions required: Edit IQ Elements
configureRepositories 1 param body → 204
GET
/api/v2/firewall/repositoryContainer
Use this method to retrieve the ID and name for the repository container. Permissions required: View IQ Elements
getRepositoryContainer → 200
GET
/api/v2/firewall/repositoryManagers
Use this method to retrieve all configured repository managers. Permissions required: View IQ Elements
getRepositoryManagers → 200
POST
/api/v2/firewall/repositoryManagers
Use this method to add a new repository manager. Permissions required: Edit IQ Elements
addRepositoryManager body → 200
DELETE
/api/v2/firewall/repositoryManagers/{repositoryManagerId}
Use this method to delete an existing repository manager. Permissions required: Edit IQ Elements
deleteRepositoryManager 1 param → 204
GET
/api/v2/firewall/repositoryManagers/{repositoryManagerId}
Use this method to retrieve details of an existing repository manager. Permissions required: View IQ Elements
getRepositoryManager 1 param → 200
POST
/api/v2/malware-defense/evaluate
Evaluate malware for a list of components. Use this endpoint to evaluate malware for a list of components up to a maximum of 100 components in a single request.A hash or packageUrl (or both) can be s…
evaluateMalware body → 200
GET
/api/v2/malware-defense/metrics
The response contains malware defense API metrics. Use this endpoint to get the count of malicious components evaluated via malware defense API grouped by format.
getMalwareDefenseMetrics → 200

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are ApiFirewallComponentDTO (11 properties), ApiFirewallQuarantinedComponentDto (11 properties), ApiPolicyViolationDTOV2 (9 properties), ContainerImageInQuarantineData (9 properties). Each schema is shown below with its type and property counts.

TriggerReference
object
2 properties
ApiFirewallComponentDTO
object
List of items for the current page
11 properties
PolicyContainerWaiverData
object
List of items for the current page
8 properties
ApiRepositoryManagerDTO
object
5 properties
CascadeComponentProgressDTO
object
4 properties
ApiFirewallReleaseQuarantineConfigDTO
object
3 properties
CascadeReevaluateTicketDTO
object
1 property
ApiPolicyViolationDTOV2
object
9 properties
ApplicationSummaryList
object
1 property
ApiMalwareComponentEvaluationRequest
object
2 properties
ComponentIdentifier
object
2 properties
MalwareCategory
object
2 properties
ApiConstraintViolationReasonDTO
object
2 properties
ApplicationSummary
object
3 properties
ApiRepositoryContainerDTO
object
3 properties
ApiFirewallQuarantinedComponentDtoResult
object
5 properties
ApiFirewallQuarantineSummaryDTO
object
5 properties
ApiContainerImageWaiverDTO
object
3 properties
ContainerImageInQuarantineDataResult
object
5 properties
CascadeStatusResponseDTO
object
5 properties
ApiMalwareComponentEvaluationRequestList
object
2 properties
ApiRepositoryListDTO
object
1 property
ApiConstraintViolationDTO
object
3 properties
ApiRepositoryComponentEvaluationResult
object
5 properties
ContainerImageInQuarantineData
object
List of items for the current page
9 properties
ApiRepositoryDTO
object
8 properties
MalwareDefenseResponseList
object
1 property
ApiFirewallQuarantinedComponentDto
object
List of items for the current page
11 properties
ApiFirewallMetricsResultDTO
object
2 properties
ApiRepositoryComponentEvaluationResultList
object
5 properties
ApiRepositoryManagerListDTO
object
1 property
ApiFirewallReleaseQuarantineSummaryDTO
object
2 properties
ApiRepositoryComponentEvaluationRequest
object
3 properties
ApiRepositoryComponentEvaluationRequestList
object
2 properties
ApiFirewallComponentDTOResult
object
5 properties
PolicyContainerWaiverDataResult
object
5 properties
MalwareDefenseData
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sonatype-firewall-api-openapi.yml Raw ↑

Other APIs Sonatype publishes across the network.

Sonatype Advanced Search API
AE Profile APIs.io
Sonatype Application Categories API
AE Profile APIs.io
Sonatype Application Report Data API
AE Profile APIs.io
Sonatype Applications API
AE Profile APIs.io
Sonatype Audit Logs API
AE Profile APIs.io
Sonatype Auto Policy Waiver Exclusions API
AE Profile APIs.io
Sonatype Auto Policy Waivers API
AE Profile APIs.io
Sonatype CI Configuration API
AE Profile APIs.io
Sonatype Claim Components API
AE Profile APIs.io
Sonatype Component Labels API
AE Profile APIs.io
Sonatype Component Search API
AE Profile APIs.io
Sonatype Components API
AE Profile APIs.io
#Firewall
← Back to S APIs
API Details
ID
sonatype:sonatype-firewall-api
Base URL
https://{iq-server-host}/
Docs
https://help.sonatype.com/en/iq-api-reference.html
Provider
Sonatype
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sonatype-firewall-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sonatype-firewall-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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