Nexus Repository Manager Components API

The Components API from Nexus Repository Manager — 2 operation(s) for components.

OpenAPI Specification

nexus-components-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Sonatype Nexus Repository REST Assets Components 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: Components
paths:
  /v1/components:
    get:
      summary: List components in a repository
      operationId: listComponents
      tags:
      - Components
      parameters:
      - in: query
        name: repository
        required: true
        schema:
          type: string
      - in: query
        name: continuationToken
        schema:
          type: string
      responses:
        '200':
          description: Page of components
    post:
      summary: Upload a component
      operationId: uploadComponent
      tags:
      - Components
      parameters:
      - in: query
        name: repository
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Component uploaded
  /v1/components/{id}:
    get:
      summary: Get a component by ID
      operationId: getComponent
      tags:
      - Components
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Component details
    delete:
      summary: Delete a component by ID
      operationId: deleteComponent
      tags:
      - Components
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Component deleted
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.

        '