Sonatype Nexus Repository

Sonatype Nexus Repository Instance configuration API

The Instance configuration API from Sonatype Nexus Repository — 5 operation(s) for instance configuration.

GitHub OpenAPI

Operations 7

GET /v1/configuration Export instance configuration #
PUT /v1/configuration Apply instance configuration #
POST /v1/configuration/cipher Set migration cipher password for decrypting imported secrets #
DELETE /v1/configuration/cipher Clear migration cipher password #
GET /v1/configuration/assets List assets #
POST /v1/configuration/assets/{repositoryName}/import Import assets to repository #
POST /v1/configuration/transfer-complete Receive transfer complete notification from migrator #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nexus/openapi/nexus-instance-configuration-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-asset-import-response-xo-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-transfer-complete-xo-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-configuration-apply-response-xo-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-page-schema.json
📊
JSONSchema
https://artifacts.apis.io/nexus/json-schema/nexus-instance-configuration-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-instance-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-instance-configuration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nexus Repository Manager REST Instance configuration API
  version: 3.97.2-02
servers:
- url: /service/rest
tags:
- name: Instance configuration
paths:
  /v1/configuration:
    get:
      tags:
      - Instance configuration
      summary: Export instance configuration
      operationId: listConfiguration
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceConfigurationXO'
        '400':
          description: Missing or invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                type: string
    put:
      tags:
      - Instance configuration
      summary: Apply instance configuration
      operationId: updateConfiguration
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceConfigurationXO'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationApplyResponseXO'
        '400':
          description: Invalid request or missing/invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                type: string
  /v1/configuration/cipher:
    post:
      tags:
      - Instance configuration
      summary: Set migration cipher password for decrypting imported secrets
      operationId: createConfigurationCipher
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      requestBody:
        description: Cipher password as plain text
        content:
          text/plain:
            schema:
              type: string
        required: true
      responses:
        '200':
          description: Cipher password set successfully
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Missing password or invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Failed to set cipher password
          content:
            application/json:
              schema:
                type: string
    delete:
      tags:
      - Instance configuration
      summary: Clear migration cipher password
      operationId: deleteConfigurationCipher
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Cipher password cleared successfully
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Missing or invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Failed to clear cipher password
          content:
            application/json:
              schema:
                type: string
  /v1/configuration/assets:
    get:
      tags:
      - Instance configuration
      summary: List assets
      operationId: listConfigurationAssets
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      - name: continuationToken
        in: query
        description: A token returned by a prior request. If present, the next page of results are returned
        schema:
          type: string
      - name: repository
        in: query
        description: Repository from which you would like to retrieve assets.
        required: true
        schema:
          type: string
      - name: newerThan
        in: query
        description: Unix timestamp (milliseconds since epoch). Return assets last updated after this timestamp
        schema:
          type: integer
          format: int64
      - name: olderThan
        in: query
        description: Unix timestamp (milliseconds since epoch). Return assets last updated before this timestamp
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page'
        '400':
          description: Missing or invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions to list assets
        '422':
          description: Parameter 'repository' is required
  /v1/configuration/assets/{repositoryName}/import:
    post:
      tags:
      - Instance configuration
      summary: Import assets to repository
      operationId: createConfigurationAssetsImport
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      - name: repositoryName
        in: path
        description: Repository name to import assets to
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Assets imported successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetImportResponseXO'
        '400':
          description: Repository not found or missing/invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Asset import failed
          content:
            application/json:
              schema:
                type: string
  /v1/configuration/transfer-complete:
    post:
      tags:
      - Instance configuration
      summary: Receive transfer complete notification from migrator
      operationId: createConfigurationTransferComplete
      parameters:
      - name: X-Nexus-Migration-Protocol-Version
        in: header
        description: Migration protocol version spoken by the calling migration tool, for example '2'. A version this instance cannot serve is rejected with 400.
        required: true
        schema:
          type: string
      requestBody:
        description: Transfer completion notification data
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferCompleteXO'
        required: true
      responses:
        '200':
          description: Transfer complete notification received
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Missing notification data, repository name, or invalid protocol version
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                type: string
        '403':
          description: Insufficient permissions
          content:
            application/json:
              schema:
                type: string
        '500':
          description: Failed to process notification
          content:
            application/json:
              schema:
                type: string
components:
  schemas:
    AssetImportResponseXO:
      type: object
      properties:
        assetId:
          type: string
        path:
          type: string
        repository:
          type: string
        componentId:
          type: string
        importTimestamp:
          type: string
          format: date-time
        status:
          type: string
          enum:
          - SUCCESS
          - SUCCESS_WITH_WARNINGS
          - SKIPPED_ALREADY_EXISTS
          - FAILED
        warnings:
          type: array
          items:
            type: string
        errorMessage:
          type: string
    Page:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
        continuationToken:
          type: string
        total:
          type: integer
          format: int64
    InstanceConfigurationXO:
      type: object
      properties:
        configurationXOs:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationXO'
    ConfigurationApplyResponseXO:
      type: object
      properties:
        appliedConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ApplyStatusXO'
        notAppliedConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ApplyStatusXO'
        failedConfigurations:
          type: array
          items:
            $ref: '#/components/schemas/ApplyStatusXO'
    ApplyStatusXO:
      type: object
      properties:
        status:
          type: string
          enum:
          - APPLIED
          - NOT_APPLIED
          - FAILED
        message:
          type: string
        entity:
          type: string
    TransferCompleteXO:
      type: object
      properties:
        successful:
          type: boolean
        repositoryName:
          type: string
        successfulAssetTransferCount:
          type: integer
          format: int64
        skippedAssetTransferCount:
          type: integer
          format: int64
        failedAssetTransferCount:
          type: integer
          format: int64
        message:
          type: string
        timestamp:
          type: integer
          format: int64
    ConfigurationXO:
      type: object
      properties:
        configurationTypeId:
          type: string