Update a Pipeline

Update pipeline properties using JSON Patch

PATCH /v1/pipelines/{id}

PATCH /v1/pipelines/{id}

Python

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}")

Response

{
  "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

id · string · required

UUID of the pipeline to update.

Update by Name

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

fqn · 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.

description · string

Updated description in Markdown format.

displayName · string

Updated display name.

sourceUrl · string

Updated source URL.

tasks · array

Updated list of pipeline tasks.

Show properties

name · string

Name of the task.

taskType · string

Type of the task.

description · string

Description of the task.

downstreamTasks · array

Array of downstream task names.

owners · array

Updated list of owner references.

Show properties

id · string

UUID of the owner entity.

type · string

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

tags · array

Updated classification tags.

Show properties

tagFQN · string · required

Fully qualified name of the tag.

labelType · string

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

state · string

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

domain · string

Updated domain FQN.

extension · object

Updated custom property values.

PATCH /v1/pipelines/{id}

Python

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}")

Response

{
  "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

id · string

Unique identifier for the pipeline (UUID format).

name · string

Pipeline name.

fullyQualifiedName · string

Fully qualified name in format service.pipelineName.

description · string

Updated description.

version · 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