Sonatype

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.

GitHub OpenAPI

Operations 4

DELETE /api/v2/config #
GET /api/v2/config #
PUT /api/v2/config #
DELETE /api/v2/config/integrationVersions/cache #

Documentation

📖
Documentation
https://help.sonatype.com/en/iq-api-reference.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/openapi/sonatype-configuration-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-application-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/sonatype/refs/heads/main/json-schema/sonatype-policy-violation-schema.json

Other Resources

🔗
Reference
https://help.sonatype.com/en/rest-apis.html

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/sonatype-configuration-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

sonatype-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sonatype Lifecycle Public REST Advanced Search Configuration API
  version: 1.201.0-02
  description: Use the Advanced Search REST API to perform searches on Lifecycle application scan reports.
security:
- BasicAuth: []
  BearerAuth: []
tags:
- 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.'
  name: Configuration
paths:
  /api/v2/config:
    delete:
      description: 'Use this method to disable one or more IQ Server system properties. The property names are case-sensitive.


        Permissions required: Edit System Configuration and Users'
      operationId: deleteConfiguration_1
      parameters:
      - description: Enter the names of the system properties. Values provided for name are case-sensitive.
        in: query
        name: property
        schema:
          items:
            $ref: '#/components/schemas/SystemConfigProperty'
          type: array
          uniqueItems: true
      responses:
        204:
          content: {}
          description: System Configuration removed
      tags:
      - Configuration
    get:
      description: 'Use this method to retrieve the configured value for an IQ Server system property.


        Permissions required: Edit System Configuration and Users or system property dependent'
      operationId: getConfiguration_1
      parameters:
      - description: Enter the names of the system properties. Values provided for name are case-sensitive.
        in: query
        name: property
        schema:
          items:
            $ref: '#/components/schemas/SystemConfigProperty'
          type: array
          uniqueItems: true
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemConfig'
          description: System Configuration retrieved
      tags:
      - Configuration
    put:
      description: 'Use this method to configure one or more IQ Server system properties. The property names are case-sensitive.


        Permissions required: Edit System Configuration and Users'
      operationId: setConfiguration_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemConfig'
      responses:
        204:
          content: {}
          description: System Configuration updated
      tags:
      - Configuration
  /api/v2/config/integrationVersions/cache:
    delete:
      description: 'Clear the integration version cache. Use this endpoint after a new integration version is released to ensure IQ Server immediately recognizes the new version instead of waiting for cache expiration (10 minutes).


        Permissions required: Edit System Configuration and Users'
      operationId: invalidateCache
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CacheInvalidationResponse'
          description: Cache cleared successfully. Returns the number of entries that were invalidated.
      tags:
      - Configuration
components:
  schemas:
    CacheInvalidationResponse:
      properties:
        entriesInvalidated:
          format: int64
          type: integer
      type: object
    SystemConfigProperty:
      enum:
      - baseUrl
      - forceBaseUrl
      type: string
    SystemConfig:
      properties:
        baseUrl:
          type:
          - string
          - 'null'
        forceBaseUrl:
          type:
          - boolean
          - 'null'
  securitySchemes:
    BasicAuth:
      scheme: basic
      type: http
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http