Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ZenML Pipeline Runs API

Pipeline run instances and their steps

ZenML Pipeline Runs API is one of 14 APIs that ZenML publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 5 JSON Schema definitions.

Tagged areas include Pipeline Runs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, a GitHub repository, and 5 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against a single base URL, https://your-zenml-server.example.com/api/v1.

2 operations 2 paths 4 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Server
https://your-zenml-server.example.com/api/v1
Authentication
HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 1

ZenML Pipeline Runs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Pipeline Runs 2

Pipeline run instances and their steps

GET
/runs
List Pipeline Runs
listPipelineRuns 4 params → 200
GET
/runs/{run_id}
Get Pipeline Run
getPipelineRun 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are PipelineRun (9 properties), Page (4 properties). Each schema is shown below with its type and property counts.

RunStatus
string
Page
object
4 properties
PipelineRunPage
PipelineRun
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenml-pipeline-runs-api-openapi.yml Raw ↑

Other APIs ZenML publishes across the network.

ZenML Pro REST API
ZenML Artifacts API
ZenML Auth API
ZenML Deployments API
ZenML Models API
ZenML Pipelines API
ZenML Projects API
ZenML Schedules API
ZenML Secrets API
ZenML Service Connectors API
ZenML Stack Components API
ZenML Stacks API