Skip to main content
DELETE
https://sandbox.getcollate.io/api
/
v1
/
services
/
storageServices
/
{id}
DELETE /v1/services/storageServices/{id}
from metadata.sdk import configure
from metadata.sdk.entities import StorageServices

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

# Soft delete by ID
StorageServices.delete("d1589e1d-2ab0-431c-a383-15e4be20a106")

# Hard delete
StorageServices.delete(
    "d1589e1d-2ab0-431c-a383-15e4be20a106",
    hard_delete=True
)

# Delete by name
StorageServices.delete_by_name("s3_datalake")

# Delete by name with options
StorageServices.delete_by_name(
    "s3_datalake",
    hard_delete=True,
    recursive=True
)

# Restore a soft-deleted storage service
StorageServices.restore("d1589e1d-2ab0-431c-a383-15e4be20a106")

{
  "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
  "name": "s3_datalake",
  "fullyQualifiedName": "s3_datalake",
  "serviceType": "S3",
  "description": "Production S3 data lake for analytics",
  "connection": {
    "config": {
      "type": "S3",
      "awsConfig": {
        "enabled": false,
        "awsAccessKeyId": "AKIA...",
        "awsSecretAccessKey": "*********",
        "awsRegion": "us-east-1",
        "endPointURL": "https://s3.amazonaws.com/"
      }
    }
  },
  "version": 0.2,
  "updatedAt": 1769982621820,
  "updatedBy": "admin",
  "owners": [],
  "tags": [],
  "deleted": true,
  "domains": []
}

​
Delete a Storage Service

Delete a storage 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 storage service to delete.
​
recursive
boolean
default:"false"
Recursively delete child entities (containers).
​
hardDelete
boolean
default:"false"
Permanently delete the storage service. If false, the storage service is soft-deleted and can be restored.

​
Delete by Name

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

​
Restore a Soft-Deleted Storage Service

Use PUT /v1/services/storageServices/restore to restore a soft-deleted storage service.
​
id
string
required
UUID of the soft-deleted storage service to restore.
DELETE /v1/services/storageServices/{id}
from metadata.sdk import configure
from metadata.sdk.entities import StorageServices

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

# Soft delete by ID
StorageServices.delete("d1589e1d-2ab0-431c-a383-15e4be20a106")

# Hard delete
StorageServices.delete(
    "d1589e1d-2ab0-431c-a383-15e4be20a106",
    hard_delete=True
)

# Delete by name
StorageServices.delete_by_name("s3_datalake")

# Delete by name with options
StorageServices.delete_by_name(
    "s3_datalake",
    hard_delete=True,
    recursive=True
)

# Restore a soft-deleted storage service
StorageServices.restore("d1589e1d-2ab0-431c-a383-15e4be20a106")

{
  "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
  "name": "s3_datalake",
  "fullyQualifiedName": "s3_datalake",
  "serviceType": "S3",
  "description": "Production S3 data lake for analytics",
  "connection": {
    "config": {
      "type": "S3",
      "awsConfig": {
        "enabled": false,
        "awsAccessKeyId": "AKIA...",
        "awsSecretAccessKey": "*********",
        "awsRegion": "us-east-1",
        "endPointURL": "https://s3.amazonaws.com/"
      }
    }
  },
  "version": 0.2,
  "updatedAt": 1769982621820,
  "updatedBy": "admin",
  "owners": [],
  "tags": [],
  "deleted": true,
  "domains": []
}

​
Returns

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

​
Error Handling

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