Sonatype Nexus Repository

Sonatype Nexus Repository Manage Sonatype Repository Firewall configuration API

The Manage Sonatype Repository Firewall configuration API from Sonatype Nexus Repository — 9 operation(s) for manage sonatype repository firewall configuration.

GitHub OpenAPI

Operations 11

GET /v1/iq/audit List repositories audit statuses #
PUT /v1/iq/audit Manage audit #
GET /v1/iq/audit/{repositoryName} Get audit status for the repository #
POST /v1/iq/disable Disable Sonatype Repository Firewall #
POST /v1/iq/enable Enable Sonatype Repository Firewall #
GET /v1/iq/capabilities Get IQ Server capabilities (Firewall and Lifecycle) #
POST /v1/iq/capabilities/test Get IQ Server capabilities for a specific configuration #
GET /v1/iq Get Sonatype Repository Firewall configuration #
PUT /v1/iq Update Sonatype Repository Firewall configuration #
POST /v1/iq/test-new-connection Test new Sonatype Repository Firewall connection #
POST /v1/iq/verify-connection Verify Sonatype Repository Firewall connection #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nexus/openapi/nexus-manage-sonatype-repository-firewall-configuration-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-iq-connection-xo-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-iq-capabilities-xo-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-iq-audit-xo-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-iq-connection-verification-xo-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nexus:nexus-manage-sonatype-repository-firewall-configuration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

nexus-manage-sonatype-repository-firewall-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nexus Repository Manager REST Manage Sonatype Repository…
  version: 3.97.2-02
servers:
- url: /service/rest
tags:
- name: Manage Sonatype Repository Firewall configuration
paths:
  /v1/iq/audit:
    get:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: List repositories audit statuses
      operationId: listIqAudit
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IqAuditXo'
    put:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Manage audit
      operationId: updateIqAudit
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IqAuditXo'
      responses:
        '400':
          description: Given repository is not a proxy
        '404':
          description: Given repository not found
        '204':
          description: Repository audit is successfully updated
  /v1/iq/audit/{repositoryName}:
    get:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Get audit status for the repository
      operationId: getIqAudit
      parameters:
      - name: repositoryName
        in: path
        required: true
        schema:
          type: string
      responses:
        '404':
          description: Given repository not found
        '400':
          description: Given repository is not a proxy
  /v1/iq/disable:
    post:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Disable Sonatype Repository Firewall
      operationId: createIqDisable
      responses:
        '204':
          description: Sonatype Repository Firewall has been disabled
        '400':
          description: Sonatype Repository Firewall connection not configured
  /v1/iq/enable:
    post:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Enable Sonatype Repository Firewall
      operationId: createIqEnable
      responses:
        '204':
          description: Sonatype Repository Firewall has been enabled
        '400':
          description: Sonatype Repository Firewall connection not configured
  /v1/iq/capabilities:
    get:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Get IQ Server capabilities (Firewall and Lifecycle)
      operationId: listIqCapabilities
      responses:
        '200':
          description: IQ Server capabilities returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IqCapabilitiesXo'
  /v1/iq/capabilities/test:
    post:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Get IQ Server capabilities for a specific configuration
      operationId: createIqCapabilitiesTest
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IqConnectionXo'
        required: true
      responses:
        '200':
          description: IQ Server capabilities returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IqCapabilitiesXo'
  /v1/iq:
    get:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Get Sonatype Repository Firewall configuration
      operationId: listIq
      responses:
        '200':
          description: Sonatype Repository Firewall configuration returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IqConnectionXo'
    put:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Update Sonatype Repository Firewall configuration
      operationId: updateIq
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IqConnectionXo'
        required: true
      responses:
        '200':
          description: Sonatype Repository Firewall configuration updated, returns the current configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IqConnectionXo'
  /v1/iq/test-new-connection:
    post:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Test new Sonatype Repository Firewall connection
      operationId: createIqTestNewConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IqConnectionXo'
        required: true
      responses:
        '200':
          description: Connection test complete, check response body for result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IqConnectionVerificationXo'
  /v1/iq/verify-connection:
    post:
      tags:
      - Manage Sonatype Repository Firewall configuration
      summary: Verify Sonatype Repository Firewall connection
      operationId: createIqVerifyConnection
      responses:
        '200':
          description: Connection verification complete, check response body for result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IqConnectionVerificationXo'
components:
  schemas:
    IqCapabilitiesXo:
      type: object
      properties:
        hasFirewall:
          type: boolean
          description: Whether the IQ instance has access to Repository Firewall
        hasLifecycle:
          type: boolean
          description: Whether the IQ instance has access to Sonatype Lifecycle
        connected:
          type: boolean
          description: Whether the IQ instance is currently connected
        url:
          type: string
          description: The IQ Server URL
        deploymentId:
          type: string
          description: The deployment ID for constructing deep links
    IqConnectionVerificationXo:
      type: object
      properties:
        success:
          type: boolean
        reason:
          type: string
        applicationCount:
          type: integer
          format: int32
    LicensedSolutionXO:
      required:
      - id
      - url
      type: object
      properties:
        id:
          type: string
          description: Solution identifier (lifecycle, firewall, sbom, developer)
          example: lifecycle
        url:
          type: string
          description: Dashboard URL for this solution
          example: http://iq-server/ui/links/lifecycle
      description: Licensed Solution
    IqAuditXo:
      required:
      - enabledQuarantine
      - repositoryName
      type: object
      properties:
        enabled:
          type: boolean
          description: is audit enabled
        repositoryName:
          type: string
          description: repository name
        enabledQuarantine:
          type: boolean
          description: is quarantine enabled
    IqConnectionXo:
      required:
      - authenticationType
      - url
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether to use Sonatype Repository Firewall
        showLink:
          type: boolean
          description: Show Sonatype Repository Firewall link in Browse menu when server is enabled
        url:
          minLength: 1
          type: string
          description: The address of your Sonatype Repository Firewall
        authenticationType:
          type: string
          description: Authentication method
          enum:
          - USER
          - PKI
        username:
          type: string
          description: User with access to Sonatype Repository Firewall
        password:
          type: string
          description: Credentials for the Sonatype Repository Firewall User
        useTrustStoreForUrl:
          type: boolean
          description: Use certificates stored in the Nexus Repository Manager truststore to connect to Sonatype Repository Firewall
        timeoutSeconds:
          maximum: 3600
          minimum: 1
          type: integer
          description: Seconds to wait for activity before stopping and retrying the connection. Leave blank to use the globally defined HTTP timeout.
          format: int32
        properties:
          type: string
          description: Additional properties to configure for Sonatype Repository Firewall
        failOpenModeEnabled:
          type: boolean
          description: Allow by default when quarantine is enabled and the IQ connection fails
          example: false
        licensedSolutions:
          type: array
          description: List of licensed solutions available in the connected IQ Server
          items:
            $ref: '#/components/schemas/LicensedSolutionXO'
        hasFirewall:
          type: boolean
          description: Whether the connected IQ Server has Firewall enabled