GitLab ML Model Registry API

openapi: 3.2.0
info:
  title: GitLab REST ML Model Registry API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: ML Model Registry
  description: 'Use this API to upload and download the files attached to a version of a machine learning model in

    the model registry. To create models and model

    versions, use an MLflow client.'
  x-displayName: ML Model Registry
  externalDocs:
    url: https://docs.gitlab.com/api/model_registry/
paths:
  /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{file_name}/authorize:
    put:
      operationId: putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileNameAuthorize
      summary: Workhorse authorize model package file
      description: Introduced in GitLab 16.8
      tags:
      - ML Model Registry
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: The ID or URL-encoded path of the project
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: file_name
        required: true
        description: File name
        schema:
          type: string
        in: path
      - name: model_version_id
        required: true
        description: Model version id
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileNameAuthorizeRequest'
  /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{path}/{file_name}/authorize:
    put:
      operationId: putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileNameAuthorize
      summary: Workhorse authorize model package file
      description: Introduced in GitLab 16.8
      tags:
      - ML Model Registry
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: The ID or URL-encoded path of the project
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: file_name
        required: true
        description: File name
        schema:
          type: string
        in: path
      - name: path
        required: true
        description: File directory path
        schema:
          type: string
        in: path
      - name: model_version_id
        required: true
        description: Model version id
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileNameAuthorizeRequest'
  /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{file_name}:
    put:
      operationId: putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileName
      summary: Workhorse upload model package file
      description: Introduced in GitLab 16.8
      tags:
      - ML Model Registry
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: The ID or URL-encoded path of the project
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: file_name
        required: true
        description: File name
        schema:
          type: string
        in: path
      - name: model_version_id
        required: true
        description: Model version id
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileNameRequest'
    get:
      operationId: getApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileName
      summary: Download an ml_model package file
      description: This feature was introduced in GitLab 16.8
      tags:
      - ML Model Registry
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: The ID or URL-encoded path of the project
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: file_name
        required: true
        description: File name
        schema:
          type: string
        in: path
      - name: status
        required: false
        description: Package status
        schema:
          type:
          - string
          - 'null'
          enum:
          - default
          - hidden
          - null
        in: query
      - name: model_version_id
        required: true
        description: Model version id
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/packages/ml_models/{model_version_id}/files/{path}/{file_name}:
    put:
      operationId: putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileName
      summary: Workhorse upload model package file
      description: Introduced in GitLab 16.8
      tags:
      - ML Model Registry
      responses:
        '201':
          description: Created
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: The ID or URL-encoded path of the project
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: file_name
        required: true
        description: File name
        schema:
          type: string
        in: path
      - name: path
        required: true
        description: File directory path
        schema:
          type: string
        in: path
      - name: model_version_id
        required: true
        description: Model version id
        schema:
          type: string
        in: path
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileNameRequest'
    get:
      operationId: getApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileName
      summary: Download an ml_model package file
      description: This feature was introduced in GitLab 16.8
      tags:
      - ML Model Registry
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: The ID or URL-encoded path of the project
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      - name: file_name
        required: true
        description: File name
        schema:
          type: string
        in: path
      - name: path
        required: true
        description: File directory path
        schema:
          type: string
        in: path
      - name: status
        required: false
        description: Package status
        schema:
          type:
          - string
          - 'null'
          enum:
          - default
          - hidden
          - null
        in: query
      - name: model_version_id
        required: true
        description: Model version id
        schema:
          type: string
        in: path
components:
  schemas:
    putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileNameRequest:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          enum:
          - default
          - hidden
          - null
          description: Package status
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The package file to be published (generated by Multipart middleware)
      required:
      - file
    putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileNameRequest:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          enum:
          - default
          - hidden
          - null
          description: Package status
        file:
          type:
          - string
          - 'null'
          format: binary
          description: The package file to be published (generated by Multipart middleware)
      required:
      - file
    putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesPathFileNameAuthorizeRequest:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          enum:
          - default
          - hidden
          - null
          description: Package status
    putApiV4ProjectsIdPackagesMlModelsModelVersionIdFilesFileNameAuthorizeRequest:
      type: object
      properties:
        status:
          type:
          - string
          - 'null'
          enum:
          - default
          - hidden
          - null
          description: Package status
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header