Pipelines API Reference (v1beta1)
Old Version
This page is about Kubeflow Pipelines V1, please see the V2 documentation for the latest information.
Note, while the V2 backend is able to run pipelines submitted by the V1 SDK, we strongly recommend migrating to the V2 SDK.
For reference, the final release of the V1 SDK was kfp==1.8.22, and its reference documentation is available here.
This document describes the API specification for the v1beta1 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/.
Tip
We recommend using the Kubeflow Pipelines Python SDK as it provides a more user-friendly interface. See the Connect SDK to the API guide for more information.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/v1beta1/runs?resource_reference_key.type=NAMESPACE&resource_reference_key.id=team-1
Swagger UI
The following Swagger UI is automatically generated from the 2.3.0 version of Kubeflow Pipelines for the v1beta1 REST API.
Note
The try it out feature of Swagger UI does not work due to authentication and CORS, but it can help you construct the correct API calls.Feedback
Was this page helpful?
Thank you for your feedback!
We're sorry this page wasn't helpful. If you have a moment, please share your feedback so we can improve.