MLflow:Rest
lastmod 2026-04-01created 2026-04-012 edits
The MLflow REST API lets you create, list, and get experiments and runs, and log parameters, metrics, and artifacts.
API Path
The API is hosted under the /api path of the MLflow tracking server.
For example, to search experiments on a tracking server hosted at http://localhost:5000, send a POST request to http://localhost:5000/api/2.0/mlflow/experiments/search.
| INFORMATION |
| The MLflow REST API requires the |
API List
- #Create Experiment - Creates an experiment with a name and returns the new experiment ID.
- #Search Experiments - Searches experiments. Supports filtering, sorting, and pagination.
- #Get Experiment - Gets the metadata of an experiment. Works on deleted experiments as well.
- #Get Experiment By Name - Gets the metadata of an experiment by name.
- #Delete Experiment - Marks an experiment and its associated metadata, runs, metrics, parameters, and tags for deletion.
- #Restore Experiment - Restores an experiment marked for deletion and its associated metadata.
- #Update Experiment - Updates experiment metadata.
- #Set Experiment Tag - Sets a tag on an experiment. Tags are metadata unrelated to runs.
- #Delete Experiment Tag - Deletes a tag from an experiment.
- #Create Run - Creates a new run within an experiment. A single execution unit of an ML or ETL pipeline.
- #Update Run - Updates run metadata.
- #Delete Run - Marks a run for deletion.
- #Restore Run - Restores a deleted run.
- #Get Run - Gets the metadata, metrics, parameters, and tags of a run.
- #Search Runs - Searches runs by metric/parameter conditions.
- #Log Metric - Logs a metric (string key, float value, timestamp) to a run.
- #Log Param - Logs a parameter (string key-value pair) to a run. Can be logged only once per run.
- #Log Batch - Logs metrics, parameters, and tags to a run in a batch.
- #Log Model - [Experimental] Logs a model to a run.
- #Log Inputs - Logs dataset inputs to a run.
- #Set Tag - Sets a tag on a run. Can be updated during or after the run.
- #Delete Tag - Deletes a tag from a run.
- #Get Metric History - Gets the list of all values for the specified metric of a given run.
- #List Artifacts - Lists the artifacts of a run. Can be filtered by path prefix.
- #Register Scorer - Registers a scorer to an experiment.
- #List Scorers - Lists all scorers of an experiment.
- #List Scorer Versions - Lists all versions of a given scorer.
- #Get Scorer - Gets a given scorer of an experiment.
- #Delete Scorer - Deletes a scorer from an experiment.
- #Create Gateway Secret - Creates an encrypted secret for LLM provider authentication.
- #Get Gateway Secret Info - Gets the metadata of a secret (excluding the encrypted value).
- #Update Gateway Secret - Updates the value or authentication settings of an existing secret.
- #Delete Gateway Secret - Deletes a secret.
- #List Gateway Secrets - Lists all secrets. Supports filtering by provider.
- #Create Gateway Model Definition - Creates a reusable model definition.
- #Get Gateway Model Definition - Gets a model definition by ID.
- #List Gateway Model Definitions - Lists all model definitions. Supports filter options.
- #Update Gateway Model Definition - Updates a model definition.
- #Delete Gateway Model Definition - Deletes a model definition (fails if it is in use by an endpoint).
- #Create Gateway Endpoint - Creates a new endpoint with model configurations.
- #Get Gateway Endpoint - Gets endpoint details including all model configurations.
- #Update Gateway Endpoint - Updates the name of an endpoint.
- #Delete Gateway Endpoint - Deletes an endpoint and all its model configurations.
- #List Gateway Endpoints - Lists endpoints. Supports filtering by provider/secret.
- #Attach Model to Endpoint - Attaches an existing model definition to an endpoint.
- #Detach Model from Endpoint - Detaches a model definition from an endpoint (the model definition is not deleted).
- #Create Endpoint Binding - Creates a binding between an endpoint and an MLflow resource.
- #Delete Endpoint Binding - Deletes a binding between an endpoint and a resource.
- #List Endpoint Bindings - Lists all bindings of an endpoint.
- #Gateway Set Endpoint Tag - Sets a tag on an endpoint.
- #Gateway Delete Endpoint Tag - Deletes a tag from an endpoint.
- #Create Prompt Optimization Job - Creates a new prompt optimization job and starts the optimization run.
- #Get Prompt Optimization Job - Gets the details and status of a prompt optimization job.
- #Search Prompt Optimization Jobs - Searches prompt optimization jobs matching filter conditions.
- #Cancel Prompt Optimization Job - Cancels an in-progress prompt optimization job.
- #Delete Prompt Optimization Job - Permanently deletes a prompt optimization job and its associated data.
- #Create Budget Policy - Creates a new budget policy.
- #Get Budget Policy - Gets a budget policy by ID.
- #Update Budget Policy - Updates a budget policy.
- #Delete Budget Policy - Deletes a budget policy.
- #List Budget Policies - Lists budget policies.
- #List Budget Windows - Lists budget windows along with current spending information.
- #Create RegisteredModel - Creates a registered model. Fails if one with the same name already exists.
- #Get RegisteredModel - Gets the details of a registered model.
- #Rename RegisteredModel - Renames a registered model.
- #Update RegisteredModel - Updates metadata such as the description of a registered model.
- #Delete RegisteredModel - Deletes a registered model.
- #Search RegisteredModels - Searches registered models. Supports filtering, sorting, and pagination.
- #Get Latest ModelVersions - Gets the latest model versions of a registered model. Supports filtering by stage.
- #Create ModelVersion - Creates a new model version.
- #Get ModelVersion - Gets the details of a model version.
- #Update ModelVersion - Updates the description of a model version.
- #Delete ModelVersion - Deletes a model version.
- #Search ModelVersions - Searches model versions. Supports filtering, sorting, and pagination.
- #Get Download URI For ModelVersion Artifacts - Gets the download URI for model version artifacts.
- #Transition ModelVersion Stage - Transitions the stage of a model version (e.g. Staging → Production).
- #Set Registered Model Tag - Sets a tag on a registered model.
- #Set Model Version Tag - Sets a tag on a model version.
- #Delete Registered Model Tag - Deletes a tag from a registered model.
- #Delete Model Version Tag - Deletes a tag from a model version.
- #Set Registered Model Alias - Sets an alias on a registered model.
- #Delete Registered Model Alias - Deletes an alias from a registered model.
- #Get Model Version by Alias - Gets a model version by alias.
- #Create Webhook - Creates a webhook.
- #List Webhooks - Gets the list of webhooks.
- #Get Webhook - Gets the details of a webhook.
- #Update Webhook - Updates a webhook.
- #Delete Webhook - Deletes a webhook.
- #Test Webhook - Tests a webhook.
- #Download Artifact - Downloads an artifact.
- #Upload Artifact - Uploads an artifact.
- #List Artifacts - Lists artifacts.
- #Delete Artifacts - Deletes artifacts.
- #Create an Artifact Multipart Upload - Creates an artifact multipart upload.
- #Complete an Artifact Multipart Upload - Completes an artifact multipart upload.
- #Abort an Artifact Multipart Upload - Aborts an artifact multipart upload.
- #Get Presigned URL for Multipart Download - Gets a presigned URL for multipart download.
- #Data Structures - Definitions of the data structures used in the API (Experiment, Run, Metric, Param, ModelVersion, etc.).