Netcracker Admin API

openapi: 3.2.0
info:
  title: Netcracker Admin API
  version: '2026.1'
  contact:
    name: Netcracker Opensource Group
    email: opensourcegroup@netcracker.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  x-api-kind: BWC
  description: 'Operations tagged Admin across 2 of this provider''s published API definitions: netcracker-qubership-apihub-admin-openapi.yml, netcracker-qubership-apihub-registry-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{apihub}.qubership.org
  description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
  variables:
    apihub:
      description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
      enum:
      - apihub
      - dev.apihub
      - staging.apihub
      default: apihub
security:
- BearerAuth: []
- CookieAuth: []
- api-key: []
- PersonalAccessToken: []
tags:
- name: Admin
  description: APIs for technical administration.
paths:
  /api/v1/builds:
    get:
      tags:
      - Admin
      summary: List builds
      description: 'Return a page of builds with persisted build configuration. If no filter is provided, the latest builds are returned first.

        '
      operationId: listBuilds
      parameters:
      - name: packageId
        in: query
        required: false
        description: Filter builds by package ID.
        schema:
          type: string
      - name: version
        in: query
        required: false
        description: Filter builds by package version.
        schema:
          type: string
      - name: buildIds
        in: query
        required: false
        description: Comma-separated list of build IDs. When combined with other filters, all filters are applied.
        schema:
          type: string
      - name: offset
        in: query
        required: false
        description: Number of items to skip.
        schema:
          type: integer
          format: int32
          minimum: 0
          default: 0
      - name: limit
        in: query
        required: false
        description: Maximum number of items to return.
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 100
          default: 100
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedBuilds'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/v1/builds/{buildId}:
    get:
      tags:
      - Admin
      summary: Get build
      description: 'Return build data and persisted build configuration by build ID.

        '
      operationId: getBuild
      parameters:
      - name: buildId
        in: path
        required: true
        description: Build identifier string returned by build operations.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExtendedBuild'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Build not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/v2/admin/builds/{buildId}/result:
    get:
      tags:
      - Admin
      summary: Get build result archive
      description: 'Download the build result archive for a completed build. The response body is a binary stream (application/octet-stream) containing build artifacts.

        '
      operationId: getBuildResult
      parameters:
      - name: buildId
        in: path
        required: true
        description: Build identifier string returned by build operations (internal build ID).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Build result not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/v2/admin/builds/{buildId}/sources:
    get:
      tags:
      - Admin
      summary: Get build sources archive
      description: 'Download build sources archive by build ID. The archive includes an apihub_build_config.json file with the build configuration.

        '
      operationId: getBuildSources
      parameters:
      - name: buildId
        in: path
        required: true
        description: Build identifier string returned by build operations (internal build ID).
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Build sources not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/internal/migrate/operations:
    post:
      tags:
      - Admin
      summary: Start operations migration
      description: 'Start an asynchronous operations migration job. Use the returned migration ID to check status, reports, and diagnostics endpoints.

        '
      operationId: startOpsMigration
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                packageIds:
                  type: array
                  items:
                    type: string
                  description: Optional list of package IDs to migrate. If omitted, migration scope is determined by server-side defaults.
                versions:
                  type: array
                  items:
                    type: string
                  description: Optional list of versions to migrate (for example, 1.0.0 or 1.0.0@2). If omitted, all eligible versions are processed.
                rebuildChangelogOnly:
                  type: boolean
                  description: If true, only changelog data is rebuilt; no full operations migration is performed.
                  default: false
                skipValidation:
                  type: boolean
                  description: If true, pre-migration validation checks are skipped. Use with caution because invalid data may propagate to reports.
                  default: false
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Migration ID
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict - migration already running
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/internal/migrate/operations/{migrationId}:
    get:
      tags:
      - Admin
      summary: Get migration status
      description: 'Retrieve migration status and report data for a migration job identified by migrationId.

        '
      operationId: getMigrationReport
      parameters:
      - name: migrationId
        in: path
        required: true
        description: Migration job identifier returned by the start migration operation.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: Migration report
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/internal/migrate/operations/{migrationId}/suspiciousBuilds:
    get:
      tags:
      - Admin
      summary: Get suspicious builds
      description: 'Retrieve suspicious build records detected during the specified migration. Use query parameters to filter and paginate the result set.

        '
      operationId: getSuspiciousBuilds
      parameters:
      - name: migrationId
        in: path
        required: true
        description: Migration job identifier returned by the start migration operation.
        schema:
          type: string
      - name: changedField
        in: query
        required: false
        description: Optional filter by changed field name; returns only suspicious records where this field changed.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum number of items returned per page.
        schema:
          type: integer
      - name: page
        in: query
        required: false
        description: Page number for paginated results (1-based).
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/internal/migrate/operations/{migrationId}/perf:
    get:
      tags:
      - Admin
      summary: Get migration performance report
      description: 'Retrieve performance metrics for the specified migration, including stage-level timings and counters.

        '
      operationId: getMigrationPerfReport
      parameters:
      - name: migrationId
        in: path
        required: true
        description: Migration job identifier returned by the start migration operation.
        schema:
          type: string
      - name: includeHourPackageData
        in: query
        required: false
        description: If true, include per-hour package-level performance breakdowns (larger payload).
        schema:
          type: boolean
      - name: stageFilter
        in: query
        required: false
        description: Optional stage name filter to return metrics only for matching migration stages.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                description: Performance report
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/internal/migrate/operations/cancel:
    post:
      tags:
      - Admin
      summary: Cancel running migrations
      description: 'Cancel currently running migration jobs. This operation is idempotent and safely returns success when no migration is running.

        '
      operationId: cancelRunningMigrations
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/v2/packages:
    post:
      tags:
      - Admin
      summary: Create a new package
      description: Create a new package in APIHUB registry.
      operationId: postPackages
      requestBody:
        description: Package for creation
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackageCreate'
            examples: {}
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Package'
                - type: object
                  properties:
                    parents:
                      description: List of all parent packages
                      type: array
                      items:
                        $ref: '#/components/schemas/PackageList'
              examples: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/v2/packages/{packageId}:
    parameters:
    - $ref: '#/components/parameters/packageId'
    patch:
      tags:
      - Admin
      summary: Change the package's parameters
      description: 'Change the package''s parameters.

        * If the parameter is not transmitted in request - its value stays unchanged.

        * The empty parameter value in request sets the empty value in database.

        '
      operationId: patchPackagesId
      requestBody:
        description: Package update parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackageUpdate'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Package'
                - type: object
                  properties:
                    parents:
                      description: List of all parent packages
                      type: array
                      items:
                        $ref: '#/components/schemas/PackageList'
                    defaultReleaseVersion:
                      description: 'Default release version for the package.

                        Only `release` version may be placed as default. Return the error otherwise.

                        '
                      type: string
                      example: '2023.1'
              examples: {}
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    delete:
      tags:
      - Admin
      summary: Delete package
      description: Delete the package and all included published versions.
      operationId: deletePackagesId
      responses:
        '204':
          description: No content
          content: {}
        '301':
          description: Moved Permanently
          headers:
            Location:
              schema:
                type: string
              description: Current ednpoint with new packageId of moved package
            X-New-Package-Id:
              schema:
                type: string
              description: New packageId of moved package
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageNotFound:
                  $ref: '#/components/examples/PackageNotFound'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                PackageReferencedByDashboard:
                  $ref: '#/components/examples/PackageReferencedByDashboard'
                GroupOrWorkspaceReferencedByDashboard:
                  $ref: '#/components/examples/GroupOrWorkspaceReferencedByDashboard'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    servers:
    - url: https://{apihub}.qubership.org
      description: Primary APIHUB server endpoint (use the apihub variable to select production, development, or staging).
      variables:
        apihub:
          description: APIHUB subdomain/environment selector (apihub=production, dev.apihub=development, staging.apihub=staging).
          enum:
          - apihub
          - dev.apihub
          - staging.apihub
          default: apihub
  /api/v4/packages/{packageId}/apiKeys:
    parameters:
    - $ref: '#/components/parameters/packageId'
    post:
      tags:
      - Admin
      summary: Create a package API Key
      description: 'Create a package API Key.

        The Api Key for package with kind:group is acceptable for all child groups and packages.\

        If packageId = ''\*'', then system tokens shall be created. Only system administrator can specify packageId = ''\*''.

        '
      operationId: postPackagesIdApiKeysV4
      requestBody:
        description: Create API key parameters
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: API key name. Name must be unique.
                roles:
                  description: List of roles for api key. Limited by user's available roles, i.e. only available roles could be set. List of available roles could be retrieved via "/packages/{packageId}/availableRoles" endpoint.
                  type: array
                  items:
                    type: string
                createdFor:
                  type: string
                  description: id of the user for whom the API key shall be created.
                  example: user1221
              required:
              - name
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PackageApiKey'
                - type: object
                  properties:
                    apiKey:
                      description: 'Generated ApiKey. It shows only once. Need to copy to your credentials storage.

                        '
                      type: string
              examples: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                IncorrectInputParams:
                  $ref: '#/components/examples/IncorrectInputParameters'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                InternalServerError:
                  $ref: '#/components/examples/InternalServerError'
    get:
      tags:
      - Admin
      summary: Package API Keys list retrieve
      description: 'Get a package API Keys list.\

        If packageId = ''\*'', then system tokens shall be returned. Only system administrator can specify packageId = ''\*''.

        '
      operationId: getPackagesIdApiKeysV4
      responses:
        '200':
          descriptio

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netcracker/refs/heads/main/openapi/netcracker-admin-api-openapi.yml