REST API (v1alpha3)

This document describes the API specification for the v1alpha3 Kubeflow Model Registry REST API.

About the REST API

In most deployments of the Kubeflow Platform, the Kubeflow Model Registry REST API is available under the /api/model_registry/ HTTP path.

For example, if you host Kubeflow at https://kubeflow.example.com, the API will be available at https://kubeflow.example.com/api/model_registry/.

Authentication

How requests are authenticated and authorized will depend on the distribution you are using. Typically, you will need to provide a token or cookie in the request headers.

Please refer to the documentation of your Kubeflow distribution for more information.

Example Usage

To use the API, you will need to send HTTP requests to the appropriate endpoints.

For example, to list all Artifact entities, send a GET request to the following URL:

https://kubeflow.example.com/api/model_registry/v1alpha3/artifacts?pageSize=100&orderBy=ID

Swagger UI

The following Swagger UI is automatically generated from the 0.2.22 version of Kubeflow Model Registry for the v1alpha3 REST API.