PATCH /v1/pipelines/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
pipeline.description = "Updated: Analytics pipeline with incremental customer processing"
updated = Pipelines.update(pipeline)

print(f"Updated to version {updated.version}")

import static org.openmetadata.sdk.fluent.Pipelines.*;

// Retrieve, modify, and update
var pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac");
pipeline.setDescription("Updated: Analytics pipeline with incremental customer processing");
var updated = Pipelines.update(pipeline);

# Update by ID
curl -X PATCH "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Analytics pipeline with incremental customer processing"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Analytics pipeline with incremental customer processing"}
  ]'

{
  "id": "538faa63-d204-46ff-aead-d158d0401cac",
  "name": "dbt_analytics_customers",
  "displayName": "DBT Customer Analytics",
  "fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
  "description": "Updated: Analytics pipeline with incremental customer processing",
  "version": 0.2,
  "updatedAt": 1769982668397,
  "updatedBy": "admin",
  "service": {
    "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
    "type": "pipelineService",
    "name": "sample_airflow",
    "fullyQualifiedName": "sample_airflow",
    "deleted": false
  },
  "serviceType": "DBTCloud",
  "href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

PATCH

pipelines

{id}

PATCH /v1/pipelines/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
pipeline.description = "Updated: Analytics pipeline with incremental customer processing"
updated = Pipelines.update(pipeline)

print(f"Updated to version {updated.version}")

import static org.openmetadata.sdk.fluent.Pipelines.*;

// Retrieve, modify, and update
var pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac");
pipeline.setDescription("Updated: Analytics pipeline with incremental customer processing");
var updated = Pipelines.update(pipeline);

# Update by ID
curl -X PATCH "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Analytics pipeline with incremental customer processing"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Analytics pipeline with incremental customer processing"}
  ]'

{
  "id": "538faa63-d204-46ff-aead-d158d0401cac",
  "name": "dbt_analytics_customers",
  "displayName": "DBT Customer Analytics",
  "fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
  "description": "Updated: Analytics pipeline with incremental customer processing",
  "version": 0.2,
  "updatedAt": 1769982668397,
  "updatedBy": "admin",
  "service": {
    "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
    "type": "pipelineService",
    "name": "sample_airflow",
    "fullyQualifiedName": "sample_airflow",
    "deleted": false
  },
  "serviceType": "DBTCloud",
  "href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Update a Pipeline

Update a pipeline’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

string

required

UUID of the pipeline to update.

Update by Name

Use PATCH /v1/pipelines/name/{fqn} to update by fully qualified name.

string

required

Fully qualified name of the pipeline (e.g., sample_airflow.dbt_analytics_customers).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

string

Updated description in Markdown format.

string

Updated display name.

string

Updated source URL.

array

Updated list of pipeline tasks.

Show properties

string

Name of the task.

string

Type of the task.

string

Description of the task.

array

Array of downstream task names.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

array

Updated classification tags.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label (e.g., Manual, Derived, Propagated).

string

State of the tag (e.g., Suggested, Confirmed).

string

Updated domain FQN.

object

Updated custom property values.

PATCH /v1/pipelines/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac")
pipeline.description = "Updated: Analytics pipeline with incremental customer processing"
updated = Pipelines.update(pipeline)

print(f"Updated to version {updated.version}")

import static org.openmetadata.sdk.fluent.Pipelines.*;

// Retrieve, modify, and update
var pipeline = Pipelines.retrieve("538faa63-d204-46ff-aead-d158d0401cac");
pipeline.setDescription("Updated: Analytics pipeline with incremental customer processing");
var updated = Pipelines.update(pipeline);

# Update by ID
curl -X PATCH "{base_url}/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Analytics pipeline with incremental customer processing"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/pipelines/name/sample_airflow.dbt_analytics_customers" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Analytics pipeline with incremental customer processing"}
  ]'

{
  "id": "538faa63-d204-46ff-aead-d158d0401cac",
  "name": "dbt_analytics_customers",
  "displayName": "DBT Customer Analytics",
  "fullyQualifiedName": "sample_airflow.dbt_analytics_customers",
  "description": "Updated: Analytics pipeline with incremental customer processing",
  "version": 0.2,
  "updatedAt": 1769982668397,
  "updatedBy": "admin",
  "service": {
    "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
    "type": "pipelineService",
    "name": "sample_airflow",
    "fullyQualifiedName": "sample_airflow",
    "deleted": false
  },
  "serviceType": "DBTCloud",
  "href": "http://localhost:8585/api/v1/pipelines/538faa63-d204-46ff-aead-d158d0401cac",
  "deleted": false,
  "owners": [],
  "tags": [],
  "followers": [],
  "votes": {
    "upVotes": 0,
    "downVotes": 0
  },
  "domains": []
}

Returns

Returns the updated pipeline object with the new version number.

Response

string

Unique identifier for the pipeline (UUID format).

string

Pipeline name.

string

Fully qualified name in format service.pipelineName.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid JSON patch or malformed request
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this pipeline
`404`	`NOT_FOUND`	Pipeline with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Update a Pipeline

Update a Pipeline

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling

​Update a Pipeline

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update a Pipeline

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling