Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
pipelineServices
/
{id}
/
versions
GET /v1/services/pipelineServices/{id}/versions
import requests

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

# List all versions
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5/versions",
    headers=headers
)
versions = response.json()
for v in versions["versions"]:
    print(v)

# Get a specific version
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5/versions/0.1",
    headers=headers
)

{
  "entityType": "pipelineService",
  "versions": [
    "{\"id\":\"daa58a49-df05-48a3-a417-45dfd12eacf5\",\"name\":\"sample_airflow\",\"fullyQualifiedName\":\"sample_airflow\",\"version\":0.2,\"description\":\"Updated Airflow production service\",\"serviceType\":\"Airflow\"}",
    "{\"id\":\"daa58a49-df05-48a3-a417-45dfd12eacf5\",\"name\":\"sample_airflow\",\"fullyQualifiedName\":\"sample_airflow\",\"version\":0.1,\"serviceType\":\"Airflow\"}"
  ]
}

​
Pipeline Service Versions

Every change to a pipeline service 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 service.

​
Get Specific Version

Use GET /v1/services/pipelineServices/{id}/versions/{version} to retrieve a specific version.
​
id
string
required
UUID of the pipeline service.
​
version
string
required
Version number to retrieve (e.g., 0.2).
GET /v1/services/pipelineServices/{id}/versions
import requests

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

# List all versions
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5/versions",
    headers=headers
)
versions = response.json()
for v in versions["versions"]:
    print(v)

# Get a specific version
response = requests.get(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5/versions/0.1",
    headers=headers
)

{
  "entityType": "pipelineService",
  "versions": [
    "{\"id\":\"daa58a49-df05-48a3-a417-45dfd12eacf5\",\"name\":\"sample_airflow\",\"fullyQualifiedName\":\"sample_airflow\",\"version\":0.2,\"description\":\"Updated Airflow production service\",\"serviceType\":\"Airflow\"}",
    "{\"id\":\"daa58a49-df05-48a3-a417-45dfd12eacf5\",\"name\":\"sample_airflow\",\"fullyQualifiedName\":\"sample_airflow\",\"version\":0.1,\"serviceType\":\"Airflow\"}"
  ]
}

​
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 service object as it existed at that version.

​
Error Handling

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