Nexus Repository Manager Search API

The Search API from Nexus Repository Manager — 2 operation(s) for search.

OpenAPI Specification

nexus-search-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Sonatype Nexus Repository REST Assets Search API
  description: 'Sonatype Nexus Repository Manager 3 exposes a REST API

    (under /service/rest/) for managing assets, components,

    repositories, blob stores, search, security, tasks, and

    related resources. The full OpenAPI document for a given

    instance is published at /service/rest/swagger.json.

    '
  version: v1
servers:
- url: '{nexus_url}/service/rest'
  description: Sonatype Nexus Repository instance base
  variables:
    nexus_url:
      default: https://nexus.example.com
      description: The base URL of your Nexus Repository Manager instance
security:
- basicAuth: []
- userToken: []
tags:
- name: Search
paths:
  /v1/search:
    get:
      summary: Search for components
      operationId: searchComponents
      tags:
      - Search
      parameters:
      - in: query
        name: q
        schema:
          type: string
      - in: query
        name: continuationToken
        schema:
          type: string
      responses:
        '200':
          description: Search results
  /v1/search/assets:
    get:
      summary: Search for assets
      operationId: searchAssets
      tags:
      - Search
      parameters:
      - in: query
        name: q
        schema:
          type: string
      responses:
        '200':
          description: Asset search results
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication with a Nexus user account.
    userToken:
      type: http
      scheme: bearer
      description: 'Nexus user token authentication. Tokens can be generated

        per user when User Tokens are enabled on the instance.

        '