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

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

# List all versions
versions = DatabaseServices.get_versions("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
service_v1 = DatabaseServices.get_specific_version(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "0.1"
)
print(f"Original description: {service_v1.description}")
{
  "entityType": "databaseService",
  "versions": [
    "{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Updated BigQuery data service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
    "{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Sample data service for BigQuery\",\"version\":0.1,\"updatedAt\":1769982650000,\"updatedBy\":\"admin\",\"deleted\":false}"
  ]
}

Database Service Versions

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

Get Specific Version

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

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

# List all versions
versions = DatabaseServices.get_versions("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
for v in versions:
    print(f"Version {v.version}: {v.description}")

# Get a specific version
service_v1 = DatabaseServices.get_specific_version(
    "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "0.1"
)
print(f"Original description: {service_v1.description}")
{
  "entityType": "databaseService",
  "versions": [
    "{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Updated BigQuery data service\",\"version\":0.2,\"updatedAt\":1769982700000,\"updatedBy\":\"admin\",\"deleted\":false}",
    "{\"id\":\"fd2193af-fe09-4366-92b7-1e0d01cd8c09\",\"name\":\"sample_data\",\"fullyQualifiedName\":\"sample_data\",\"serviceType\":\"BigQuery\",\"description\":\"Sample data service for BigQuery\",\"version\":0.1,\"updatedAt\":1769982650000,\"updatedBy\":\"admin\",\"deleted\":false}"
  ]
}

Returns

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

Error Handling

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