Pipelines API Reference (v2beta1)

This document describes the API specification for the v2beta1 Kubeflow Pipelines REST API.

About the REST API

In most deployments of the Kubeflow Platform, the Kubeflow Pipelines REST API is available under the /pipeline/ HTTP path. For example, if you host Kubeflow at https://kubeflow.example.com, the API will be available at https://kubeflow.example.com/pipeline/.

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 pipeline runs in the team-1 namespace, send a GET request to the following URL:

https://kubeflow.example.com/pipeline/apis/v2beta1/runs?namespace=team-1

Swagger UI

The following Swagger UI is automatically generated from the 2.3.0 version of Kubeflow Pipelines for the v2beta1 REST API.