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 Deployments API

Pipeline deployments

ZenML Deployments 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 Deployments. 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 1 operation across 1 path, and defines 3 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.

1 operations 1 paths 3 schemas 1 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 Deployments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 1

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

Deployments 1

Pipeline deployments

GET
/deployments
List Pipeline Deployments
listDeployments 2 params → 200

Schemas 3

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

DeploymentPage
Page
object
4 properties
Deployment
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenml-deployments-api-openapi.yml Raw ↑

Other APIs ZenML publishes across the network.

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