How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenMetadata Pipelines API

A `Pipeline` enables the flow of data from source to destination through a series of processing steps. ETL is a type of pipeline where the series of steps Extract, Transform and Load the data.

OpenMetadata Pipelines API is one of 89 APIs that OpenMetadata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Pipelines. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 27 operations across 20 paths, and defines 47 schemas. It is described by OpenAPI 3.0.1, at version 1.13.

Requests are made against 2 base URLs: /api, http://localhost:8585/api.

27 operations 20 paths 47 schemas 5 DELETE12 GET2 PATCH1 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.13
Base URL
https://{your-host}/api/v1
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

OpenMetadata Pipelines API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 27

Across 20 paths, the API surfaces 27 operations — 5 DELETE, 12 GET, 2 PATCH, 1 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Pipelines 27

A Pipeline enables the flow of data from source to destination through a series of processing steps. ETL is a type of pipeline where the series of steps Extract, Transform and Loa…

PUT
/v1/pipelines/{fqn}/status/bulk
Add bulk status data
addBulkStatusData 1 param body → 200400
PUT
/v1/pipelines/{id}/followers
Add a follower
addFollower_9 1 param body → 200404
GET
/v1/pipelines/{fqn}/status
List pipeline status
listPipelineStatuses 10 params → 200
PUT
/v1/pipelines/{fqn}/status
Add status data
addStatusData 1 param body → 200400
PUT
/v1/pipelines/bulk
Bulk create or update pipelines
bulkCreateOrUpdatePipelines 1 param body → 200202400
GET
/v1/pipelines
List pipelines
listPipelines 6 params → 200
PUT
/v1/pipelines
Create or update a pipeline
createOrUpdatePipeline body → 200400
POST
/v1/pipelines
Create a pipeline
createPipeline body → 200400
GET
/v1/pipelines/name/{fqn}
Get a pipeline by fully qualified name
getPipelineByFQN 4 params → 200404
DELETE
/v1/pipelines/name/{fqn}
Delete a pipeline by fully qualified name
deletePipelineByFQN 3 params → 200404
PATCH
/v1/pipelines/name/{fqn}
Update a pipeline by name.
patchPipeline 1 param body → default
GET
/v1/pipelines/{id}
Get a pipeline by Id
getPipelineWithID 4 params → 200404
DELETE
/v1/pipelines/{id}
Delete a pipeline by Id
deletePipeline 3 params → 200404
PATCH
/v1/pipelines/{id}
Update a pipeline
patchPipeline_1 1 param body → default
DELETE
/v1/pipelines/async/{id}
Asynchronously delete a pipeline by Id
deletePipelineAsync 3 params → 200404
DELETE
/v1/pipelines/{id}/followers/{userId}
Remove a follower
deleteFollower_12 2 params → 200
DELETE
/v1/pipelines/{fqn}/status/{timestamp}
Delete pipeline status
DeletePipelineStatus 2 params → 200
GET
/v1/pipelines/executionTrend
Get pipeline execution trend
getPipelineExecutionTrend 11 params → 200400
GET
/v1/pipelines/metrics
Get aggregated pipeline metrics
getPipelineMetrics 9 params → 200
GET
/v1/pipelines/name/{fqn}/observability
Get pipeline observability data
getPipelineObservability_1 9 params → 200404
GET
/v1/pipelines/runtimeTrend
Get pipeline runtime trend
getPipelineRuntimeTrend 11 params → 200400
GET
/v1/pipelines/{id}/versions/{version}
Get a version of the pipeline
getSpecificPipelineVersion 2 params → 200404
GET
/v1/pipelines/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_35 5 params → 200
GET
/v1/pipelines/summary
List pipeline summaries with impacted assets count
listPipelineSummaries 13 params → 200
GET
/v1/pipelines/{id}/versions
List pipeline versions
listAllPipelineVersion 1 param → 200
PUT
/v1/pipelines/restore
Restore a soft deleted pipeline
restore_26 body → 200
PUT
/v1/pipelines/{id}/vote
Update Vote for a Entity
updateVoteForEntity_12 1 param body → 200404

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are Pipeline (42 properties), CreatePipeline (19 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

PipelineRuntimeTrend
object
6 properties 3 required
TagLabelRecognizerMetadata
object
5 properties 3 required
PipelineObservabilityResponse
object
4 properties 3 required
CreatePipeline
object
19 properties 2 required
BulkOperationResult
object
8 properties
PipelineStatusList
object
5 properties 1 required
StackTraceError
object
3 properties 2 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
Progress
object
FieldChange
object
3 properties
CoverImage
object
2 properties
RestoreEntity
object
1 property 1 required
TableObservabilityData
object
3 properties 3 required
LifeCycle
object
3 properties
PipelineList
object
5 properties 1 required
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
VoteRequest
object
1 property
ResultList
object
5 properties 1 required
ServiceBreakdown
object
3 properties
BulkResponse
object
3 properties
Paging
object
5 properties 1 required
PipelineSummaryList
object
5 properties 1 required
PipelineRuntimeTrendList
object
6 properties 2 required
JsonPatch
object
PipelineObservability
object
8 properties 1 required
ChangeDescription
object
5 properties
Task
object
12 properties 1 required
PipelineStatus
object
8 properties
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
PipelineSummary
object
11 properties 5 required
Style
object
3 properties
StepSummary
object
11 properties 1 required
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
PipelineExecutionTrend
object
8 properties 3 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
PipelineMetrics
object
10 properties 2 required
OperationMetrics
object
PipelineExecutionTrendList
object
9 properties 2 required
Pipeline
object
42 properties 3 required
EntityReference
object
9 properties 2 required
UsageDetails
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openmetadata-pipelines-api-openapi.yml Raw ↑

Other APIs OpenMetadata publishes across the network.

OpenMetadata Agent Executions API
OpenMetadata AI Applications API
OpenMetadata AI Governance Policies API
OpenMetadata API Collections API
OpenMetadata API Endpoint API
OpenMetadata API Services API
OpenMetadata Apps API
OpenMetadata Audit Logs API
OpenMetadata Bots API
OpenMetadata ChangeSummary API
OpenMetadata Charts API
OpenMetadata Classifications API
Where this information came from

This is an independent, third-party profile of OpenMetadata Pipelines API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.