Create a Pipeline Service

Create a new pipeline service connection

POST /v1/services/pipelineServices

POST /v1/services/pipelineServices

Python

import requests

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

payload = {
    "name": "sample_airflow",
    "displayName": "Sample Airflow",
    "serviceType": "Airflow",
    "description": "Production Airflow pipeline orchestrator",
    "connection": {
        "config": {
            "type": "Airflow",
            "hostPort": "http://localhost:8080",
            "connection": {
                "type": "Backend"
            }
        }
    }
}

response = requests.post(
    f"{base_url}/v1/services/pipelineServices",
    json=payload,
    headers=headers
)
service = response.json()
print(f"Created: {service['fullyQualifiedName']}")

Response

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "description": "Production Airflow pipeline orchestrator",
  "version": 0.1,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "connection": {
    "config": {
      "type": "Airflow",
      "hostPort": "http://localhost:8080",
      "connection": {
        "type": "Backend"
      }
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

Create a Pipeline Service

Create a new pipeline service connection to a platform such as Airflow, Dagster, or Fivetran.

Body Parameters

name · string · required

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

serviceType · string · required

Type of pipeline service (e.g., Airflow, GluePipeline, Airbyte, Dagster, Fivetran, DBTCloud, Nifi, DomoPipeline, CustomPipeline, Flink, KafkaConnect, SplineProducer, OpenLineage).

connection · object · required

Connection configuration specific to the service type.

Show properties

config · object

Service-specific connection configuration (e.g., host, port, authentication for Airflow).

displayName · string

Human-readable display name for the pipeline service.

description · string

Description of the pipeline service in Markdown format.

owners · array

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

Show properties

id · string

UUID of the owner entity.

type · string

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

name · string

Name of the owner entity.

domain · string

Fully qualified name of the domain to assign for governance purposes.

tags · array

Array of classification tags to apply to the pipeline service.

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).

POST /v1/services/pipelineServices

Python

import requests

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

payload = {
    "name": "sample_airflow",
    "displayName": "Sample Airflow",
    "serviceType": "Airflow",
    "description": "Production Airflow pipeline orchestrator",
    "connection": {
        "config": {
            "type": "Airflow",
            "hostPort": "http://localhost:8080",
            "connection": {
                "type": "Backend"
            }
        }
    }
}

response = requests.post(
    f"{base_url}/v1/services/pipelineServices",
    json=payload,
    headers=headers
)
service = response.json()
print(f"Created: {service['fullyQualifiedName']}")

Response

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "description": "Production Airflow pipeline orchestrator",
  "version": 0.1,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
  "connection": {
    "config": {
      "type": "Airflow",
      "hostPort": "http://localhost:8080",
      "connection": {
        "type": "Backend"
      }
    }
  },
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

---

Returns

Returns the created pipeline service object with all specified properties and system-generated fields.

Response

id · string

Unique identifier for the pipeline service (UUID format).

name · string

Pipeline service name.

fullyQualifiedName · string

Fully qualified name of the service.

displayName · string

Human-readable display name.

description · string

Description of the pipeline service in Markdown format.

serviceType · string

Type of pipeline service (e.g., Airflow, Dagster, Fivetran).

connection · object

Connection configuration for the service.

Show properties

config · object

Service-specific connection configuration.

owners · array

List of owners assigned to the pipeline service.

Show properties

id · string

UUID of the owner entity.

type · string

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

name · string

Name of the owner entity.

domain · string

Fully qualified name of the assigned domain.

tags · array

Classification tags applied to the pipeline service.

Show properties

tagFQN · string

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).

version · number

Version number for the entity (starts at 0.1).

---

Create or Update (PUT)

Use PUT /v1/services/pipelineServices instead of POST to perform an upsert. If a pipeline service with the same fullyQualifiedName already exists, it will be updated; otherwise, a new service is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/services/pipelineServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead.

---

Bulk Create or Update (PUT)

Use PUT /v1/services/pipelineServices/bulk to create or update multiple pipeline services in a single request. The request body is an array of create request objects.

curl -X PUT "{base_url}/api/v1/services/pipelineServices/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "airflow_prod", "serviceType": "Airflow", "connection": { "config": {} } },
    { "name": "dagster_prod", "serviceType": "Dagster", "connection": { "config": {} } }
  ]'

---

Error Handling

Code	Error Type	Description
400	BAD_REQUEST	Invalid request body or missing required fields
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to create pipeline services
409	ENTITY_ALREADY_EXISTS	Pipeline service with same name already exists (POST only)