> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipeline Services

> Create, retrieve, update, and delete pipeline service connections with authentication and configuration for metadata ingestion across your data infrastructure using the Collate REST API.

# Pipeline Services

A **Pipeline Service** represents a connection to a pipeline orchestration platform (e.g., Airflow, Dagster, Fivetran). It is the root of the pipeline hierarchy and contains Pipelines.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/pipelines/pipeline-service/).
</Info>

## Entity Hierarchy

Pipeline Services are at the top of the pipeline hierarchy:

<CodeGroup>
  ```txt Pipeline Service theme={null}
  PipelineService (this page)
  └── Pipeline
  ```
</CodeGroup>

## Supported Service Types

`Airflow`, `GluePipeline`, `Airbyte`, `Dagster`, `Fivetran`, `DBTCloud`, `Nifi`, `DomoPipeline`, `CustomPipeline`, `Flink`, `KafkaConnect`, `SplineProducer`, `OpenLineage`

***

## API Endpoints

| Method | Endpoint | Description |
| - | - | - |
| `PUT` | `/v1/services/pipelineServices` | [Create or update](/api-reference/data-assets/pipeline-services/create) |
| `POST` | `/v1/services/pipelineServices` | [Create (POST variant)](/api-reference/data-assets/pipeline-services/create) |
| `GET` | `/v1/services/pipelineServices` | [List services](/api-reference/data-assets/pipeline-services/list) |
| `GET` | `/v1/services/pipelineServices/{id}` | [Get by ID](/api-reference/data-assets/pipeline-services/retrieve) |
| `GET` | `/v1/services/pipelineServices/name/{fqn}` | [Get by name](/api-reference/data-assets/pipeline-services/retrieve) |
| `PATCH` | `/v1/services/pipelineServices/{id}` | [Update by ID](/api-reference/data-assets/pipeline-services/update) |
| `PATCH` | `/v1/services/pipelineServices/name/{fqn}` | [Update by name](/api-reference/data-assets/pipeline-services/update) |
| `DELETE` | `/v1/services/pipelineServices/{id}` | [Delete by ID](/api-reference/data-assets/pipeline-services/delete) |
| `DELETE` | `/v1/services/pipelineServices/name/{fqn}` | [Delete by name](/api-reference/data-assets/pipeline-services/delete) |
| `PUT` | `/v1/services/pipelineServices/restore` | [Restore](/api-reference/data-assets/pipeline-services/delete) |
| `GET` | `/v1/services/pipelineServices/{id}/versions` | [List versions](/api-reference/data-assets/pipeline-services/versions) |
| `GET` | `/v1/services/pipelineServices/{id}/versions/{version}` | [Get version](/api-reference/data-assets/pipeline-services/versions) |
| `GET` | `/v1/services/pipelineServices/name/{fqn}/export` | [Export CSV](/api-reference/data-assets/pipeline-services/import-export) |
| `PUT` | `/v1/services/pipelineServices/name/{fqn}/import` | [Import CSV](/api-reference/data-assets/pipeline-services/import-export) |
| `GET` | `/v1/services/pipelineServices/name/{fqn}/exportAsync` | [Export CSV async](/api-reference/data-assets/pipeline-services/import-export) |
| `PUT` | `/v1/services/pipelineServices/name/{fqn}/importAsync` | [Import CSV async](/api-reference/data-assets/pipeline-services/import-export) |
| `POST` | `/v1/services/pipelineServices/{id}/testConnectionResult` | [Add test connection result](/api-reference/data-assets/pipeline-services/create) |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.