POST /v1/services/pipelineServices

import requests

base_url = "https://your-company.getcollate.io/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']}")

import java.net.URI;
import org.openmetadata.schema.api.services.CreatePipelineService;
import org.openmetadata.schema.api.services.CreatePipelineService.PipelineServiceType;
import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.schema.services.connections.pipeline.AirflowConnection;
import org.openmetadata.schema.services.connections.pipeline.BackendConnection;
import org.openmetadata.schema.type.PipelineConnection;
import org.openmetadata.sdk.fluent.PipelineServices;

// client is an initialized OpenMetadataClient.
PipelineServices.setDefaultClient(client);

CreatePipelineService request = new CreatePipelineService()
    .withName("sample_airflow")
    .withServiceType(PipelineServiceType.Airflow)
    .withConnection(new PipelineConnection().withConfig(
        new AirflowConnection()
            .withHostPort(URI.create("http://localhost:8080"))
            .withConnection(new BackendConnection())));

PipelineService service = PipelineServices.create(request);

curl -X POST "{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"
        }
      }
    }
  }'

{
  "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": []
}

POST

services

pipelineServices

POST /v1/services/pipelineServices

import requests

base_url = "https://your-company.getcollate.io/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']}")

import java.net.URI;
import org.openmetadata.schema.api.services.CreatePipelineService;
import org.openmetadata.schema.api.services.CreatePipelineService.PipelineServiceType;
import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.schema.services.connections.pipeline.AirflowConnection;
import org.openmetadata.schema.services.connections.pipeline.BackendConnection;
import org.openmetadata.schema.type.PipelineConnection;
import org.openmetadata.sdk.fluent.PipelineServices;

// client is an initialized OpenMetadataClient.
PipelineServices.setDefaultClient(client);

CreatePipelineService request = new CreatePipelineService()
    .withName("sample_airflow")
    .withServiceType(PipelineServiceType.Airflow)
    .withConnection(new PipelineConnection().withConfig(
        new AirflowConnection()
            .withHostPort(URI.create("http://localhost:8080"))
            .withConnection(new BackendConnection())));

PipelineService service = PipelineServices.create(request);

curl -X POST "{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"
        }
      }
    }
  }'

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

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, SplineProducer, 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.

POST /v1/services/pipelineServices

import requests

base_url = "https://your-company.getcollate.io/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']}")

import java.net.URI;
import org.openmetadata.schema.api.services.CreatePipelineService;
import org.openmetadata.schema.api.services.CreatePipelineService.PipelineServiceType;
import org.openmetadata.schema.entity.services.PipelineService;
import org.openmetadata.schema.services.connections.pipeline.AirflowConnection;
import org.openmetadata.schema.services.connections.pipeline.BackendConnection;
import org.openmetadata.schema.type.PipelineConnection;
import org.openmetadata.sdk.fluent.PipelineServices;

// client is an initialized OpenMetadataClient.
PipelineServices.setDefaultClient(client);

CreatePipelineService request = new CreatePipelineService()
    .withName("sample_airflow")
    .withServiceType(PipelineServiceType.Airflow)
    .withConnection(new PipelineConnection().withConfig(
        new AirflowConnection()
            .withHostPort(URI.create("http://localhost:8080"))
            .withConnection(new BackendConnection())));

PipelineService service = PipelineServices.create(request);

curl -X POST "{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"
        }
      }
    }
  }'

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

string

Unique identifier for the pipeline service (UUID format).

string

Pipeline service name.

string

Fully qualified name of the service.

string

Human-readable display name.

string

Description of the pipeline service in Markdown format.

string

Type of pipeline service, for example Airflow, Dagster, Fivetran.

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

array

List of owners assigned to the pipeline 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 assigned domains.

array

Classification tags applied to the pipeline service.

Show properties

string

Fully qualified name of the tag.

string

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

string

State of the tag, for example Suggested, Confirmed.

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 ... }'

Note: PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

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)

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Create a Pipeline Service

Create a Pipeline Service

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling