MLOps

Use this API to track machine learning experiments, runs, and metrics, and to manage the model registry. These endpoints implement the MLflow REST API, so you can point an MLflow client at GitLab.

MLflow artifact API

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow-artifacts/artifacts

MLflow artifacts mapping to GitLab artifacts

Parameters

Name	Type	Description
`path` Query	String	Path to the artifact, model version id, optionally followed by path. E.g. 15/MLmodel
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Get MLflow artifact file

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow-artifacts/artifacts/{model_version}/{file_path}

Retrieves an MLflow artifact file

Parameters

Name	Type	Description
`model_version` Path, required	String	The model version
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`file_path` Path, required	—	—

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Create experiment

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/create

https://www.mlflow.org/docs/2.19.0/rest-api.html#create-experiment

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`artifact_location`	String	This will be ignored
`name` Required	String	Experiment name
`tags`	Array	Tags with information about the experiment

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowNewExperiment
`400`	Bad Request	—
`404`	Not Found	—

Delete an experiment

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/delete

https://mlflow.org/docs/2.19.0/rest-api.html#delete-experiment

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`experiment_id` Required	String	ID of the experiment

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Fetch experiment by experiment_id

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/get

https://www.mlflow.org/docs/2.19.0/rest-api.html#get-experiment

Parameters

Name	Type	Description
`experiment_id` Query	String	Experiment ID, in reference to the project Default: ``
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowGetExperiment
`400`	Bad Request	—
`404`	Not Found	—

Fetch experiment by experiment_name

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/get-by-name

https://www.mlflow.org/docs/2.19.0/rest-api.html#get-experiment-by-name

Parameters

Name	Type	Description
`experiment_name` Query	String	Experiment name Default: ``
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowGetExperiment
`400`	Bad Request	—
`404`	Not Found	—

List experiments

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/list

https://www.mlflow.org/docs/2.19.0/rest-api.html#search-experiments

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowListExperiment
`404`	Not Found	—

Search experiments

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/search

https://www.mlflow.org/docs/2.19.0/rest-api.html#search-experiments

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`filter`	String	This parameter is ignored
`max_results`	Integer	Maximum number of experiments to fetch in a page. Default is 200, maximum is 1000 Default: `200`
`order_by`	String	Order criteria. Can be by a column of the experiment (created_at, name) Default: `created_at DESC`
`page_token`	String	Token for pagination

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowListExperiment
`400`	Bad Request	—
`404`	Not Found	—

Sets a tag for an experiment

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/experiments/set-experiment-tag

https://www.mlflow.org/docs/2.19.0/rest-api.html#set-experiment-tag

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`experiment_id` Required	String	ID of the experiment
`key` Required	String	Name for the tag
`value` Required	String	Value for the tag

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Gets metric history for a run

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/metrics/get-history

https://www.mlflow.org/docs/2.19.0/rest-api.html#get-metric-history

Parameters

Name	Type	Description
`run_id` Query, required	String	UUID of the run
`metric_key` Query, required	String	Name of the metric
`max_results` Query	Integer	Maximum number of metrics to return. Default is 1000 Default: `1000`
`page_token` Query	String	Token for pagination
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowGetMetricHistory
`400`	Bad Request	—
`404`	Not Found	—

Creates a Model Version

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/create

MLFlow Model Versions map to GitLab Model Versions. https://mlflow.org/docs/2.19.0/rest-api.html#create-modelversion

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`description`	String	Optional description for model version
`name`	String	Register model under this name This field is required
`run_id`	String	Run ID of the candidate to be promoted to a model version
`tags`	Array	Additional metadata for a model version

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowModelVersion
`400`	Bad Request	—
`404`	Not Found	—

Fetch model version by name and version

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/get

https://mlflow.org/docs/2.19.0/rest-api.html#get-modelversion

Parameters

Name	Type	Description
`name` Query, required	String	Model version name
`version` Query, required	String	Model version number
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowModelVersion
`400`	Bad Request	—
`404`	Not Found	—

Fetch the download URI for the model version

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/get-download-uri

Returns version in MLflow format “mlflow-artifacts:<version>” https://mlflow.org/docs/2.19.0/rest-api.html#get-download-uri-for-modelversion-artifacts

Parameters

Name	Type	Description
`name` Query, required	String	Model version name
`version` Query, required	Integer	Model version ID
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowGetDownload
`400`	Bad Request	—
`404`	Not Found	—

Updates a Model Version

PATCH /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/model-versions/update

https://mlflow.org/docs/2.19.0/rest-api.html#update-modelversion

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`description`	String	Model version description
`name`	String	Model version name

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowModelVersion
`400`	Bad Request	—
`404`	Not Found	—

Gets a Model Version by alias

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/alias

https://mlflow.org/docs/2.19.0/rest-api.html#get-model-version-by-alias

Parameters

Name	Type	Description
`name` Query	String	The name of the model
`alias` Query	String	The alias of the model, e.g. the Semantic Version `1.0.0`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	—
`400`	Bad Request	—
`404`	Not Found	—

Creates a Registered Model

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/create

MLFlow Registered Models map to GitLab Models. https://mlflow.org/docs/2.19.0/rest-api.html#create-registeredmodel

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`description`	String	Optional description for registered model
`name` Required	String	Register models under this name
`tags`	Array	Additional metadata for registered model

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowRegisteredModel
`400`	Bad Request	—
`404`	Not Found	—

Delete a Registered Model by Name

DELETE /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/delete

https://mlflow.org/docs/2.19.0/rest-api.html#delete-registeredmodel

Parameters

Name	Type	Description
`name` Query	String	Registered model unique name identifier, in reference to the project
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowRegisteredModel
`400`	Bad Request	—
`404`	Not Found	—

Fetch a Registered Model by Name

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/get

https://www.mlflow.org/docs/2.19.0/rest-api.html#get-registeredmodel

Parameters

Name	Type	Description
`name` Query	String	Registered model unique name identifier, in reference to the project Default: ``
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowRegisteredModel
`400`	Bad Request	—
`404`	Not Found	—

Fetch the latest Model Version for the given Registered Model Name

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/get-latest-versions

https://mlflow.org/docs/2.19.0/rest-api.html#get-latest-modelversions

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`name`	String	Registered model unique name identifier, in reference to the project

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowModelVersion
`400`	Bad Request	—
`404`	Not Found	—

Search Registered Models within a project

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/search

https://mlflow.org/docs/2.19.0/rest-api.html#search-registeredmodels

Parameters

Name	Type	Description
`filter` Query	String	Filter to search models. must be in the format `name='value'`. Only filtering by name is supported
`max_results` Query	Integer	Maximum number of models desired. Default is 200. Max threshold is 1000 Default: `200`
`order_by` Query	String	Order criteria. Can be by name or last_updated_timestamp, with optional DESC or ASC (default)Valid examples: `name`, `name DESC`, `last_updated_timestamp DESC`Sorting by model metadata is not supported Default: `name ASC`
`page_token` Query	String	Token for pagination
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowRegisteredModel
`400`	Bad Request	—
`404`	Not Found	—

Update a Registered Model by Name

PATCH /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/registered-models/update

https://mlflow.org/docs/2.19.0/rest-api.html#update-registeredmodel

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`description`	String	Optional description for registered model
`name`	String	Registered model unique name identifier, in reference to the project

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowRegisteredModel
`400`	Bad Request	—
`404`	Not Found	—

Creates a Run

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/create

MLFlow Runs map to GitLab Candidates. https://www.mlflow.org/docs/2.19.0/rest-api.html#create-run

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`experiment_id` Required	Integer	Id for the experiment, relative to the project
`run_name`	String	A name for this run
`start_time`	Integer	Unix timestamp in milliseconds of when the run started Default: `0`
`tags`	Array	Tags are stored, but not displayed
`user_id`	String	This will be ignored

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowRun
`400`	Bad Request	—
`404`	Not Found	—

Delete a run

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/delete

https://mlflow.org/docs/2.19.0/rest-api.html#delete-run

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`run_id` Required	String	UUID of the run

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Gets an MLFlow Run, which maps to GitLab Candidates

GET /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/get

https://www.mlflow.org/docs/1.28.0/rest-api.html#get-run

Parameters

Name	Type	Description
`run_id` Query, required	String	UUID of the candidate
`run_uuid` Query	String	This parameter is ignored
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesMlMlflowRun
`400`	Bad Request	—
`404`	Not Found	—

Logs multiple parameters and metrics

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/log-batch

https://www.mlflow.org/docs/2.19.0/rest-api.html#log-param

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`metrics`	Array of objects	Array that contains metric information Default: `[]`
`metrics[].key` Required	String	Name for the metric
`metrics[].step`	Integer	Step at which the metric was recorded
`metrics[].timestamp` Required	Integer	Unix timestamp in milliseconds when metric was recorded
`metrics[].value` Required	Number	Value of the metric
`params`	Array of objects	Array that contains parameter information Default: `[]`
`params[].key` Required	String	Name for the metric
`params[].value` Required	String	Value of the metric
`run_id` Required	String	UUID of the run

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Logs a metric to a run

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/log-metric

https://www.mlflow.org/docs/1.28.0/rest-api.html#log-metric

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`key` Required	String	Name for the metric
`run_id` Required	String	UUID of the run
`step`	Integer	Step at which the metric was recorded
`timestamp` Required	Integer	Unix timestamp in milliseconds when metric was recorded
`value` Required	Number	Value of the metric

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Logs a parameter to a run

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/log-parameter

https://www.mlflow.org/docs/2.19.0/rest-api.html#log-param

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`key` Required	String	Name for the parameter
`run_id` Required	String	UUID of the run
`value` Required	String	Value for the parameter

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Searches runs/candidates within a project

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/search

https://www.mlflow.org/docs/2.19.0/rest-api.html#search-runsexperiment_ids supports only a single experiment ID.Introduced in GitLab 16.4

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`experiment_ids` Required	Array	IDs of the experiments to get searches from, relative to the project
`max_results`	Integer	Maximum number of runs/candidates to fetch in a page. Default is 200, maximum in 1000 Default: `200`
`order_by`	String	Order criteria. Can be by a column of the run/candidate (created_at, name) or by a metric ifprefixed by `metrics`. Valid examples: `created_at`, `created_at DESC`, `metrics.my_metric DESC`Sorting by candidate parameter or metadata is not supported Default: `created_at DESC`
`page_token`	String	Token for pagination

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowRun
`400`	Bad Request	—
`404`	Not Found	—

Sets a tag for a run

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/set-tag

https://www.mlflow.org/docs/2.19.0/rest-api.html#set-tag

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`key` Required	String	Name for the tag
`run_id` Required	String	UUID of the run
`value` Required	String	Value for the tag

Responses

Code	Description	Schema
`201`	Created	—
`400`	Bad Request	—
`404`	Not Found	—

Updates a Run

POST /api/v4/projects/{id}/ml/mlflow/api/2.0/mlflow/runs/update

MLFlow Runs map to GitLab Candidates. https://www.mlflow.org/docs/2.19.0/rest-api.html#update-run

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`

Request body (application/json)

Property	Type	Description
`end_time`	Integer	Ending time of the run
`run_id` Required	String	UUID of the candidate
`status`	String	Status of the run. Accepts: [“RUNNING”, “SCHEDULED”, “FINISHED”, “FAILED”, “KILLED”] Allowed values: `RUNNING`, `SCHEDULED`, `FINISHED`, `FAILED`, `KILLED`

Responses

Code	Description	Schema
`201`	Created	APIEntitiesMlMlflowUpdateRun
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesMlMlflowExperiment

Property	Type	Description
`artifact_location`	String	—
`experiment_id`	String	Example: `1`
`lifecycle_stage`	String	Example: `active`
`name`	String	Example: `my_experiment`
`tags`	Array of APIEntitiesMlMlflowKeyValue	—

APIEntitiesMlMlflowGetDownload

Property	Type	Description
`artifact_uri`	String	Download URI for MLflow artifact

APIEntitiesMlMlflowGetExperiment

Property	Type	Description
`experiment`	APIEntitiesMlMlflowExperiment	—

APIEntitiesMlMlflowGetMetricHistory

Property	Type	Description
`metrics`	Array of APIEntitiesMlMlflowMetric	—
`next_page_token`	String	—

APIEntitiesMlMlflowKeyValue

Property	Type	Description
`key`	String	—
`value`	String	—

APIEntitiesMlMlflowListExperiment

Property	Type	Description
`experiments`	Array of APIEntitiesMlMlflowExperiment	—

APIEntitiesMlMlflowMetric

Property	Type	Description
`key`	String	—
`step`	Integer	—
`timestamp`	Integer	Unix timestamp in milliseconds
`value`	Number	—

APIEntitiesMlMlflowModelVersion

Property	Type	Description
`aliases`	Array of strings	—
`creation_timestamp`	Integer	—
`current_stage`	String	Example: `development`
`description`	String	—
`last_updated_timestamp`	Integer	—
`name`	String	—
`run_id`	String	—
`run_link`	String	—
`source`	String	—
`status`	String	Example: `READY`
`status_message`	String	—
`tags`	Array of APIEntitiesMlMlflowKeyValue	—
`user_id`	String	—
`version`	String	—

APIEntitiesMlMlflowNewExperiment

Property	Type	Description
`experiment_id`	String	Example: `1`

APIEntitiesMlMlflowRegisteredModel

Property	Type	Description
`creation_timestamp`	Integer	—
`description`	String	—
`last_updated_timestamp`	Integer	—
`latest_versions`	Array of APIEntitiesMlMlflowModelVersion	—
`name`	String	—
`tags`	Array of APIEntitiesMlMlflowKeyValue	—
`user_id`	String	—

APIEntitiesMlMlflowRun

Property	Type	Description
`data`	Object	—
`data.metrics`	Array of APIEntitiesMlMlflowMetric	—
`data.params`	Array of APIEntitiesMlMlflowKeyValue	—
`data.tags`	Array of APIEntitiesMlMlflowKeyValue	—
`info`	APIEntitiesMlMlflowRunInfo	—

APIEntitiesMlMlflowRunInfo

Property	Type	Description
`artifact_uri`	String	—
`end_time`	Integer	Unix timestamp in milliseconds
`experiment_id`	String	—
`lifecycle_stage`	String	Example: `active`
`run_id`	String	—
`run_name`	String	—
`run_uuid`	String	—
`start_time`	Integer	Unix timestamp in milliseconds
`status`	String	Example: `FINISHED`
`user_id`	String	—

APIEntitiesMlMlflowUpdateRun

Property	Type	Description
`run_info`	APIEntitiesMlMlflowRunInfo	—

MLflow artifact API

Get MLflow artifact file

Create experiment

Delete an experiment

Fetch experiment by experiment_id

Fetch experiment by experiment_name

List experiments

Search experiments

Sets a tag for an experiment

Gets metric history for a run

Creates a Model Version

Fetch model version by name and version

Fetch the download URI for the model version

Updates a Model Version

Gets a Model Version by alias

Creates a Registered Model

Delete a Registered Model by Name

Fetch a Registered Model by Name

Fetch the latest Model Version for the given Registered Model Name

Search Registered Models within a project

Update a Registered Model by Name

Creates a Run

Delete a run

Gets an MLFlow Run, which maps to GitLab Candidates

Logs multiple parameters and metrics

Logs a metric to a run

Logs a parameter to a run

Searches runs/candidates within a project

Sets a tag for a run

Updates a Run

Schemas

APIEntitiesMlMlflowExperiment

APIEntitiesMlMlflowGetDownload

APIEntitiesMlMlflowGetExperiment

APIEntitiesMlMlflowGetMetricHistory

APIEntitiesMlMlflowKeyValue

APIEntitiesMlMlflowListExperiment

APIEntitiesMlMlflowMetric

APIEntitiesMlMlflowModelVersion

APIEntitiesMlMlflowNewExperiment

APIEntitiesMlMlflowRegisteredModel

APIEntitiesMlMlflowRun

APIEntitiesMlMlflowRunInfo

APIEntitiesMlMlflowUpdateRun

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error