Skip to main content
GET
/
v1
/
services
/
pipelineServices
/
name
/
{fqn}
/
export
GET /v1/services/pipelineServices/name/{fqn}/export
import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Synchronous export
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/export",
    headers=headers
)
csv_data = response.text
print(csv_data)

# Async export
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/exportAsync",
    headers=headers
)
print(f"Export job: {response.json()}")

# Synchronous import (dry run)
response = requests.put(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/import?dryRun=true",
    headers={**headers, "Content-Type": "text/plain"},
    data=csv_data
)
print(f"Dry run result: {response.json()}")

# Apply the import
response = requests.put(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/import?dryRun=false",
    headers={**headers, "Content-Type": "text/plain"},
    data=csv_data
)

"name,displayName,description,owner,tags,domain\ndbt_analytics_customers,DBT Customer Analytics,Analytics pipeline for customer data,team:data-engineering,Tier.Tier1,,"

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.

​
Import & Export

Export pipeline service metadata (pipelines, owners, tags) to CSV and import changes back. Supports both synchronous and asynchronous operations.

​
Export to CSV

GET /v1/services/pipelineServices/name/{fqn}/export
​
fqn
string
required
Fully qualified name of the pipeline service (e.g., sample_airflow).

​
Export Async

GET /v1/services/pipelineServices/name/{fqn}/exportAsync Returns a job ID for large exports that can be polled for completion.

​
Import from CSV

PUT /v1/services/pipelineServices/name/{fqn}/import
​
fqn
string
required
Fully qualified name of the pipeline service.
​
dryRun
boolean
default:"true"
If true, validates the CSV without applying changes. Set to false to apply.

​
Import Async

PUT /v1/services/pipelineServices/name/{fqn}/importAsync For large imports, use the async variant which returns a job ID.
GET /v1/services/pipelineServices/name/{fqn}/export
import requests

base_url = "https://your-company.getcollate.io/api"
headers = {"Authorization": "Bearer your-jwt-token"}

# Synchronous export
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/export",
    headers=headers
)
csv_data = response.text
print(csv_data)

# Async export
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/exportAsync",
    headers=headers
)
print(f"Export job: {response.json()}")

# Synchronous import (dry run)
response = requests.put(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/import?dryRun=true",
    headers={**headers, "Content-Type": "text/plain"},
    data=csv_data
)
print(f"Dry run result: {response.json()}")

# Apply the import
response = requests.put(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow/import?dryRun=false",
    headers={**headers, "Content-Type": "text/plain"},
    data=csv_data
)

"name,displayName,description,owner,tags,domain\ndbt_analytics_customers,DBT Customer Analytics,Analytics pipeline for customer data,team:data-engineering,Tier.Tier1,,"

​
Returns

Export returns CSV text with headers and rows for each child entity. Import returns a summary of changes applied (or validation results for dry run).

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission for import/export
404NOT_FOUNDPipeline service with given FQN does not exist
400BAD_REQUESTInvalid CSV format or content