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

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

# Soft delete by ID
requests.delete(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    headers=headers
)

# Hard delete with recursive
requests.delete(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?hardDelete=true&recursive=true",
    headers=headers
)

# Delete by name
requests.delete(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow",
    headers=headers
)

# Restore a soft-deleted pipeline service
requests.put(
    f"{base_url}/v1/services/pipelineServices/restore",
    json={"id": "daa58a49-df05-48a3-a417-45dfd12eacf5"},
    headers={**headers, "Content-Type": "application/json"}
)

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "version": 0.2,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Delete a Pipeline Service

Delete a pipeline service by ID or fully qualified name. Supports soft delete (default), hard delete, and restore operations.

​
Delete by ID

​
id
string
required
UUID of the pipeline service to delete.
​
recursive
boolean
default:"false"
Recursively delete child entities (pipelines).
​
hardDelete
boolean
default:"false"
Permanently delete the pipeline service. If false, the service is soft-deleted and can be restored.

​
Delete by Name

Use DELETE /v1/services/pipelineServices/name/{fqn} to delete by fully qualified name.
​
fqn
string
required
Fully qualified name of the pipeline service (e.g., sample_airflow).
​
recursive
boolean
default:"false"
Recursively delete child entities.
​
hardDelete
boolean
default:"false"
Permanently delete the pipeline service.

​
Restore a Soft-Deleted Pipeline Service

Use PUT /v1/services/pipelineServices/restore to restore a soft-deleted pipeline service.
​
id
string
required
UUID of the soft-deleted pipeline service to restore.
DELETE /v1/services/pipelineServices/{id}
import requests

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

# Soft delete by ID
requests.delete(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5",
    headers=headers
)

# Hard delete with recursive
requests.delete(
    f"{base_url}/v1/services/pipelineServices/daa58a49-df05-48a3-a417-45dfd12eacf5?hardDelete=true&recursive=true",
    headers=headers
)

# Delete by name
requests.delete(
    f"{base_url}/v1/services/pipelineServices/name/sample_airflow",
    headers=headers
)

# Restore a soft-deleted pipeline service
requests.put(
    f"{base_url}/v1/services/pipelineServices/restore",
    json={"id": "daa58a49-df05-48a3-a417-45dfd12eacf5"},
    headers={**headers, "Content-Type": "application/json"}
)

{
  "id": "daa58a49-df05-48a3-a417-45dfd12eacf5",
  "name": "sample_airflow",
  "fullyQualifiedName": "sample_airflow",
  "serviceType": "Airflow",
  "version": 0.2,
  "updatedAt": 1769982621418,
  "updatedBy": "admin",
  "deleted": true,
  "owners": [],
  "tags": [],
  "domains": []
}

​
Returns

Soft delete returns the pipeline service object with deleted: true. Hard delete returns no content (204). Restore returns the restored pipeline service object.

​
Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to delete this pipeline service
404NOT_FOUNDPipeline service with given ID or FQN does not exist