Sonatype Nexus Repository Hosted Repository Evaluation API

The Hosted Repository Evaluation API from Sonatype Nexus Repository — 4 operation(s) for hosted repository evaluation.

Documentation GitHub OpenAPI

Operations 7

GET /v1/evaluation/settings Get global evaluation settings #

PATCH /v1/evaluation/settings Update global evaluation settings #

PUT /v1/evaluation/settings-with-repos Atomically update global evaluation settings and enable repository monitoring… #

PATCH /v1/evaluation/settings-with-repos Partially update global evaluation settings and/or repository monitoring (PATCH) #

PATCH /v1/evaluation/repositories Independently update monitored repositories (add/remove without changing… #

GET /v1/repositories/{repositoryName}/evaluation-settings Get evaluation settings for a repository #

PUT /v1/repositories/{repositoryName}/evaluation-settings Update evaluation settings for a repository #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/nexus/openapi/nexus-hosted-repository-evaluation-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/nexus/json-schema/nexus-patch-global-settings-and-repositories-request-xo-schema.json

📊

JSONSchema

https://artifacts.apis.io/nexus/json-schema/nexus-global-evaluation-settings-xo-schema.json

📊

JSONSchema

https://artifacts.apis.io/nexus/json-schema/nexus-global-settings-with-repositories-xo-schema.json

📊

JSONSchema

https://artifacts.apis.io/nexus/json-schema/nexus-patch-global-settings-and-repositories-response-xo-schema.json

📊

JSONSchema

https://artifacts.apis.io/nexus/json-schema/nexus-repository-evaluation-settings-xo-schema.json

📊

JSONSchema

https://artifacts.apis.io/nexus/json-schema/nexus-update-settings-request-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-hosted-repository-evaluation-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

openapi: 3.2.0
info:
  title: Nexus Repository Manager REST Hosted Repository Evaluation…
  version: 3.97.2-02
servers:
- url: /service/rest
tags:
- name: Hosted Repository Evaluation
paths:
  /v1/evaluation/settings:
    get:
      tags:
      - Hosted Repository Evaluation
      summary: Get global evaluation settings
      operationId: listEvaluationSettings
      responses:
        '200':
          description: Global evaluation settings retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalEvaluationSettingsXO'
        '403':
          description: Insufficient permissions to read global evaluation settings
    patch:
      tags:
      - Hosted Repository Evaluation
      summary: Update global evaluation settings
      operationId: updateEvaluationSettings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSettingsRequestXO'
        required: true
      responses:
        '200':
          description: Settings updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateSettingsResponseXO'
        '400':
          description: Invalid input
        '403':
          description: Insufficient permissions
        '409':
          description: Settings not yet initialised — use PUT first
  /v1/evaluation/settings-with-repos:
    put:
      tags:
      - Hosted Repository Evaluation
      summary: Atomically update global evaluation settings and enable repository monitoring…
      operationId: updateEvaluationSettingsWithRepos
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GlobalSettingsWithRepositoriesXO'
        required: true
      responses:
        '200':
          description: Global evaluation settings and repository monitoring updated successfully in a single transaction. A scope or stage change is then applied to existing evaluation jobs in the background.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsWithRepositoriesResponseXO'
        '400':
          description: Invalid input - bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsWithRepositoriesResponseXO'
        '403':
          description: Insufficient permissions to update global evaluation settings
        '500':
          description: Failed to enable monitoring for some repositories - entire transaction rolled back
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalSettingsWithRepositoriesResponseXO'
    patch:
      tags:
      - Hosted Repository Evaluation
      summary: Partially update global evaluation settings and/or repository monitoring (PATCH)
      operationId: patchV1EvaluationSettingsWithRepos
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesRequestXO'
        required: true
      responses:
        '200':
          description: Global evaluation settings and/or repository monitoring updated successfully. A scope or stage change is then applied to existing evaluation jobs in the background.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesResponseXO'
        '400':
          description: Invalid input - at least one parameter required
        '403':
          description: Insufficient permissions to update global evaluation settings
        '500':
          description: Failed to update - transaction rolled back
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesResponseXO'
      x-operation-id-source: normalized
      x-operation-id-original: updateEvaluationSettingsWithRepos
  /v1/evaluation/repositories:
    patch:
      tags:
      - Hosted Repository Evaluation
      summary: Independently update monitored repositories (add/remove without changing…
      operationId: updateEvaluationRepositories
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesRequestXO'
        required: true
      responses:
        '200':
          description: Repository monitoring updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesResponseXO'
        '400':
          description: Invalid input - at least one of addRepositoryIds or removeRepositoryIds required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesResponseXO'
        '403':
          description: Insufficient permissions to update repository monitoring
        '500':
          description: Failed to update monitoring for some repositories
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchGlobalSettingsAndRepositoriesResponseXO'
  /v1/repositories/{repositoryName}/evaluation-settings:
    get:
      tags:
      - Hosted Repository Evaluation
      summary: Get evaluation settings for a repository
      operationId: getRepositoriesEvaluationSettings
      parameters:
      - name: repositoryName
        in: path
        description: Repository name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Evaluation settings retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryEvaluationSettingsXO'
        '400':
          description: Invalid repository type or request
        '403':
          description: Insufficient permissions to access repository
        '404':
          description: Repository not found
    put:
      tags:
      - Hosted Repository Evaluation
      summary: Update evaluation settings for a repository
      operationId: updateRepositoriesEvaluationSettings
      parameters:
      - name: repositoryName
        in: path
        description: Repository name
        required: true
        schema:
          type: string
      requestBody:
        description: Evaluation settings
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RepositoryEvaluationSettingsXO'
        required: true
      responses:
        '200':
          description: Evaluation settings updated successfully
        '400':
          description: Invalid settings provided
        '403':
          description: Insufficient permissions to modify repository
        '404':
          description: Repository not found
components:
  schemas:
    RepositoryEvaluationSettingsXO:
      required:
      - mode
      type: object
      properties:
        mode:
          type: string
          description: Evaluation mode
          example: INHERIT
          enum:
          - INHERIT
          - OVERRIDE
          - DISABLE
        activityTimeFrame:
          maximum: 365
          minimum: 1
          type: integer
          description: Activity time frame in days (inherited from global settings when mode is INHERIT)
          format: int32
          example: 30
        artifactLatestVersions:
          maximum: 100
          minimum: 1
          type: integer
          description: Number of latest artifact versions to evaluate (inherited from global settings when mode is INHERIT)
          format: int32
          example: 1
        policyEvaluationStage:
          pattern: build|stage-release|release|operate
          type: string
          description: Policy evaluation stage (inherited from global settings when mode is INHERIT)
          example: build
          enum:
          - build
          - stage-release
          - release
          - operate
      description: Repository evaluation settings
    PatchGlobalSettingsAndRepositoriesResponseXO:
      type: object
      properties:
        success:
          type: boolean
          description: Whether the operation succeeded
          example: true
        settingsUpdated:
          type: boolean
          description: Whether global settings were updated
          example: true
        repositoriesAdded:
          type: integer
          description: Count of repositories added to monitoring
          format: int32
          example: 2
        repositoriesRemoved:
          type: integer
          description: Count of repositories removed from monitoring
          format: int32
          example: 1
        failed:
          type: object
          additionalProperties:
            type: string
            description: Map of repository IDs that failed with error messages
            example: '{"550e8400-e29b-41d4-a716-446655440000":"Repository not found"}'
          description: Map of repository IDs that failed with error messages
          example:
            550e8400-e29b-41d4-a716-446655440000: Repository not found
        errorMessage:
          type: string
          description: Error message if operation failed
          example: At least one parameter required
      description: PatchGlobalSettingsAndRepositoriesResponse
    PatchGlobalSettingsAndRepositoriesRequestXO:
      type: object
      properties:
        activityTimeFrame:
          minimum: 1
          type: integer
          description: Activity time frame in days (optional)
          format: int32
          example: 30
        artifactLatestVersions:
          minimum: 1
          type: integer
          description: Number of latest artifact versions to track (optional)
          format: int32
          example: 5
        policyEvaluationStage:
          type: string
          description: Policy evaluation stage (optional)
          example: RELEASE
          enum:
          - BUILD
          - STAGE_RELEASE
          - RELEASE
          - OPERATE
        autoEnrollNewRepos:
          type: boolean
          description: Enable auto-enrollment for new hosted repositories (optional)
          example: false
        addRepositoryIds:
          maxItems: 500
          minItems: 0
          type: array
          description: Repository IDs to add to monitoring (optional)
          example:
          - 550e8400-e29b-41d4-a716-446655440000
          items:
            type: string
            description: Repository IDs to add to monitoring (optional)
            example: '["550e8400-e29b-41d4-a716-446655440000"]'
        removeRepositoryIds:
          maxItems: 500
          minItems: 0
          type: array
          description: Repository IDs to remove from monitoring (optional)
          example:
          - 550e8400-e29b-41d4-a716-446655440001
          items:
            type: string
            description: Repository IDs to remove from monitoring (optional)
            example: '["550e8400-e29b-41d4-a716-446655440001"]'
      description: PatchGlobalSettingsAndRepositoriesRequest
    UpdateSettingsRequestXO:
      type: object
      properties:
        activityTimeFrame:
          maximum: 365
          minimum: 1
          type: integer
          format: int32
        artifactLatestVersions:
          maximum: 20
          minimum: 1
          type: integer
          format: int32
        policyEvaluationStage:
          pattern: ^(BUILD|STAGE_RELEASE|RELEASE|OPERATE)$
          type: string
        autoEnrollNewRepos:
          type: boolean
    GlobalEvaluationSettingsXO:
      required:
      - activityTimeFrame
      - artifactLatestVersions
      - policyEvaluationStage
      type: object
      properties:
        activityTimeFrame:
          minimum: 1
          type: integer
          description: Number of days to look back for activity
          format: int32
          example: 30
        artifactLatestVersions:
          minimum: 1
          type: integer
          description: Number of latest versions to evaluate per artifact
          format: int32
          example: 5
        policyEvaluationStage:
          pattern: ^(BUILD|STAGE_RELEASE|RELEASE|OPERATE)$
          type: string
          description: Policy evaluation stage
          example: RELEASE
          enum:
          - BUILD
          - STAGE_RELEASE
          - RELEASE
          - OPERATE
        autoEnrollNewRepos:
          type: boolean
          description: Whether to automatically enroll new repositories for monitoring
          example: false
        monitoredRepoCount:
          type: integer
          description: Number of repositories currently being monitored
          format: int32
          readOnly: true
          example: 42
        totalRepoCount:
          type: integer
          description: Total number of repositories in the system
          format: int32
          readOnly: true
          example: 100
        numberOfCustomRepositories:
          type: integer
          description: Number of repositories with custom evaluation settings overrides
          format: int32
          readOnly: true
          example: 2
    GlobalSettingsWithRepositoriesXO:
      required:
      - activityTimeFrame
      - artifactLatestVersions
      - autoEnrollNewRepos
      - policyEvaluationStage
      - repositoryIds
      type: object
      properties:
        activityTimeFrame:
          minimum: 1
          type: integer
          description: Number of days to look back for activity
          format: int32
          example: 30
        artifactLatestVersions:
          minimum: 1
          type: integer
          description: Number of latest versions to evaluate per artifact
          format: int32
          example: 5
        policyEvaluationStage:
          pattern: ^(BUILD|STAGE_RELEASE|RELEASE|OPERATE)$
          type: string
          description: Policy evaluation stage
          example: RELEASE
          enum:
          - BUILD
          - STAGE_RELEASE
          - RELEASE
          - OPERATE
        autoEnrollNewRepos:
          type: boolean
          description: Whether to automatically enroll new repositories for monitoring
          example: false
        repositoryIds:
          maxItems: 5000
          minItems: 1
          type: array
          description: List of repository IDs to enable monitoring for
          example:
          - uuid1
          - uuid2
          - uuid3
          items:
            type: string
            description: List of repository IDs to enable monitoring for
            example: '["uuid1","uuid2","uuid3"]'
    GlobalSettingsWithRepositoriesResponseXO:
      type: object
      properties:
        success:
          type: boolean
          description: Success status
          example: true
        message:
          type: string
          description: Response message
          example: Global settings updated successfully
        errorCode:
          type: integer
          description: Error code (only present on failure)
          format: int32
          example: 500
    UpdateSettingsResponseXO:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string