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 Pipeline Services API

The Pipeline Services API from OpenMetadata — 11 operation(s) for pipeline services.

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

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

This API exposes 17 operations across 11 paths, and defines 29 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.

17 operations 11 paths 29 schemas 4 DELETE6 GET2 PATCH1 POST4 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 Pipeline Services API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 17

Across 11 paths, the API surfaces 17 operations — 4 DELETE, 6 GET, 2 PATCH, 1 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Pipeline Services 17
PUT
/v1/services/pipelineServices/{id}/followers
Add a follower
addFollowerToDatabaseService_2 1 param body → 200404
PUT
/v1/services/pipelineServices/{id}/testConnectionResult
Add test connection result
addTestConnectionResult_9 1 param body → 200
GET
/v1/services/pipelineServices
List pipeline services
listPipelineService 6 params → 200
PUT
/v1/services/pipelineServices
Update pipeline service
createOrUpdatePipelineService body → 200400
POST
/v1/services/pipelineServices
Create a pipeline service
createPipelineService body → 200400
GET
/v1/services/pipelineServices/name/{fqn}
Get pipeline service by fully qualified name
getPipelineServiceByFQN 4 params → 200404
DELETE
/v1/services/pipelineServices/name/{fqn}
Delete a pipeline service by fully qualified name
deletePipelineServiceByName 3 params → 200404
PATCH
/v1/services/pipelineServices/name/{fqn}
Update a pipeline service using name.
patchPipelineService 1 param body → default
GET
/v1/services/pipelineServices/{id}
Get a pipeline service by Id
getPipelineServiceByID 4 params → 200404
DELETE
/v1/services/pipelineServices/{id}
Delete a pipeline service by Id
deletePipelineService 3 params → 200404
PATCH
/v1/services/pipelineServices/{id}
Update a pipeline service
patchPipelineService_1 1 param body → default
DELETE
/v1/services/pipelineServices/async/{id}
Asynchronously delete a pipeline service by Id
deletePipelineServiceAsync 3 params → 200404
DELETE
/v1/services/pipelineServices/{id}/followers/{userId}
Remove a follower
deleteFollower_24 2 params → 200
GET
/v1/services/pipelineServices/{id}/versions/{version}
Get a version of the pipeline service
getSpecificPipelineService 2 params → 200404
GET
/v1/services/pipelineServices/history
List all entity versions within a time range
listAllEntityVersionsByTimestamp_50 5 params → 200
GET
/v1/services/pipelineServices/{id}/versions
List pipeline service versions
listAllPipelineServiceVersion 1 param → 200
PUT
/v1/services/pipelineServices/restore
Restore a soft deleted pipeline service.
restore_40 body → 200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are PipelineService (36 properties), CreatePipelineService (14 properties), ChangeEvent (14 properties), TagLabel (13 properties). Each schema is shown below with its type and property counts.

TagLabelRecognizerMetadata
object
5 properties 3 required
ChangeSummaryMap
object
AccessDetails
object
3 properties 1 required
RestoreEntity
object
1 property 1 required
CoverImage
object
2 properties
FieldChange
object
3 properties
LifeCycle
object
3 properties
EntityHistory
object
2 properties 2 required
AssetCertification
object
3 properties 3 required
ResultList
object
5 properties 1 required
Paging
object
5 properties 1 required
TestConnectionResult
object
3 properties 1 required
JsonPatch
object
ChangeDescription
object
5 properties
PipelineService
object
36 properties 3 required
ChangeEvent
object
14 properties 5 required
UsageStats
object
2 properties 1 required
PipelineConnection
object
1 property
Style
object
3 properties
Votes
object
4 properties
TagLabel
object
13 properties 4 required
PatternMatch
object
3 properties 2 required
CreatePipelineService
object
14 properties 2 required
TagLabelMetadata
object
2 properties
EntityError
object
2 properties
PipelineServiceList
object
5 properties 1 required
TestConnectionStepResult
object
5 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-pipeline-services-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 Pipeline Services 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.