Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
pipelines
/
{id}
/
versions
GET /v1/pipelines/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List all versions
versions = Pipelines.get_versions("538faa63-d204-46ff-aead-d158d0401cac")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
pipeline_v1 = Pipelines.get_specific_version(
    "538faa63-d204-46ff-aead-d158d0401cac",
    "0.1"
)
print(f"Original description: {pipeline_v1.description}")
{
  "entityType": "pipeline",
  "versions": [
    "{\"id\":\"538faa63-d204-46ff-aead-d158d0401cac\",\"name\":\"dbt_analytics_customers\",\"fullyQualifiedName\":\"sample_airflow.dbt_analytics_customers\",\"version\":0.2,\"description\":\"Updated: Analytics pipeline with incremental customer processing\",\"serviceType\":\"DBTCloud\"}",
    "{\"id\":\"538faa63-d204-46ff-aead-d158d0401cac\",\"name\":\"dbt_analytics_customers\",\"fullyQualifiedName\":\"sample_airflow.dbt_analytics_customers\",\"version\":0.1,\"description\":\"Analytics pipeline for customer data processing\",\"serviceType\":\"DBTCloud\"}"
  ]
}

Pipeline Versions

Every change to a pipeline entity creates a new version. Use these endpoints to view the version history and retrieve specific versions.

List Versions

id
string
required
UUID of the pipeline.

Get Specific Version

Use GET /v1/pipelines/{id}/versions/{version} to retrieve a specific version.
id
string
required
UUID of the pipeline.
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/pipelines/{id}/versions
from metadata.sdk import configure
from metadata.sdk.entities import Pipelines

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List all versions
versions = Pipelines.get_versions("538faa63-d204-46ff-aead-d158d0401cac")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
pipeline_v1 = Pipelines.get_specific_version(
    "538faa63-d204-46ff-aead-d158d0401cac",
    "0.1"
)
print(f"Original description: {pipeline_v1.description}")
{
  "entityType": "pipeline",
  "versions": [
    "{\"id\":\"538faa63-d204-46ff-aead-d158d0401cac\",\"name\":\"dbt_analytics_customers\",\"fullyQualifiedName\":\"sample_airflow.dbt_analytics_customers\",\"version\":0.2,\"description\":\"Updated: Analytics pipeline with incremental customer processing\",\"serviceType\":\"DBTCloud\"}",
    "{\"id\":\"538faa63-d204-46ff-aead-d158d0401cac\",\"name\":\"dbt_analytics_customers\",\"fullyQualifiedName\":\"sample_airflow.dbt_analytics_customers\",\"version\":0.1,\"description\":\"Analytics pipeline for customer data processing\",\"serviceType\":\"DBTCloud\"}"
  ]
}

Returns

List versions returns an object with entityType and a versions array of serialized entity snapshots (newest first). Get specific version returns the full pipeline object as it existed at that version.

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
404NOT_FOUNDPipeline or version does not exist