PUT /v1/services/pipelineServices

curl -X PUT "{base_url}/api/v1/services/pipelineServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_airflow",
    "serviceType": "Airflow",
    "description": "Production Airflow pipeline orchestrator",
    "connection": {
      "config": {
        "type": "Airflow",
        "hostPort": "http://localhost:8080",
        "connection": {
          "type": "Backend"
        }
      }
    }
  }'

import requests

base_url = "https://your-company.open-metadata.org/api"
headers = {
    "Authorization": "Bearer your-jwt-token",
    "Content-Type": "application/json-patch+json"
}

# Update by ID
response = requests.patch(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    json=[
        {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
    ],
    headers=headers
)
updated = response.json()
print(f"Updated to version {updated['version']}")

import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.sdk.fluent.PipelineServices;

// Retrieve, modify, and update
PipelineService service = PipelineServices.retrieve("daa58a49-df05-48a3-a417-45dfd12eacf5");
service.setDescription("Updated Airflow production service");
PipelineService updated = PipelineServices.update(service);

# Update by ID
curl -X PATCH "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/services/pipelineServices/name/sample_airflow" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
  ]'

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "description": "Updated Airflow production service",
  "version": 0.2,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

PUT

services

pipelineServices

PUT /v1/services/pipelineServices

curl -X PUT "{base_url}/api/v1/services/pipelineServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_airflow",
    "serviceType": "Airflow",
    "description": "Production Airflow pipeline orchestrator",
    "connection": {
      "config": {
        "type": "Airflow",
        "hostPort": "http://localhost:8080",
        "connection": {
          "type": "Backend"
        }
      }
    }
  }'

import requests

base_url = "https://your-company.open-metadata.org/api"
headers = {
    "Authorization": "Bearer your-jwt-token",
    "Content-Type": "application/json-patch+json"
}

# Update by ID
response = requests.patch(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    json=[
        {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
    ],
    headers=headers
)
updated = response.json()
print(f"Updated to version {updated['version']}")

import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.sdk.fluent.PipelineServices;

// Retrieve, modify, and update
PipelineService service = PipelineServices.retrieve("daa58a49-df05-48a3-a417-45dfd12eacf5");
service.setDescription("Updated Airflow production service");
PipelineService updated = PipelineServices.update(service);

# Update by ID
curl -X PATCH "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/services/pipelineServices/name/sample_airflow" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
  ]'

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "description": "Updated Airflow production service",
  "version": 0.2,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Update a Pipeline Service

Create a pipeline service or update it if it already exists, using PUT /v1/services/pipelineServices with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the pipeline service. Must be unique across all pipeline services.

string

required

Type of pipeline service, for example Airflow, GluePipeline, Airbyte, Dagster, Fivetran, DBTCloud, Nifi, DomoPipeline, CustomPipeline, Flink, KafkaConnect, Spline, OpenLineage.

object

required

Connection configuration specific to the service type.

Show properties

object

Service-specific connection configuration, such as the hostPort and connection fields for Airflow.

string

Human-readable display name for the pipeline service.

string

Description of the pipeline service in Markdown format.

array

Array of owner references (users or teams) to assign to the service.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Fully qualified names of the domains to assign for governance purposes.

array

Array of classification tags to apply to the pipeline service.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

PUT /v1/services/pipelineServices

curl -X PUT "{base_url}/api/v1/services/pipelineServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "sample_airflow",
    "serviceType": "Airflow",
    "description": "Production Airflow pipeline orchestrator",
    "connection": {
      "config": {
        "type": "Airflow",
        "hostPort": "http://localhost:8080",
        "connection": {
          "type": "Backend"
        }
      }
    }
  }'

import requests

base_url = "https://your-company.open-metadata.org/api"
headers = {
    "Authorization": "Bearer your-jwt-token",
    "Content-Type": "application/json-patch+json"
}

# Update by ID
response = requests.patch(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    json=[
        {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
    ],
    headers=headers
)
updated = response.json()
print(f"Updated to version {updated['version']}")

import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.sdk.fluent.PipelineServices;

// Retrieve, modify, and update
PipelineService service = PipelineServices.retrieve("daa58a49-df05-48a3-a417-45dfd12eacf5");
service.setDescription("Updated Airflow production service");
PipelineService updated = PipelineServices.update(service);

# Update by ID
curl -X PATCH "{base_url}/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/services/pipelineServices/name/sample_airflow" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated Airflow production service"}
  ]'

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "description": "Updated Airflow production service",
  "version": 0.2,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "deleted": false,
  "owners": [],
  "tags": [],
  "domains": []
}

Returns

Returns the updated pipeline service object with the new version number.

Response

string

Unique identifier for the pipeline service (UUID format).

string

Pipeline service name.

string

Fully qualified name of the service.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this pipeline service
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

Collaboration

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Pipeline Service

Update a Pipeline Service

Body Parameters

Returns

Response

Error Handling