Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
services
/
storageServices
/
{id}
GET /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"
)

# Get by ID
svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106")
print(f"{svc.fullyQualifiedName}: {svc.serviceType}")

# Get by ID with fields
svc = StorageServices.retrieve(
    "d1589e1d-2ab0-431c-a383-15e4be20a106",
    fields=["owners", "tags"]
)

# Get by fully qualified name
svc = StorageServices.retrieve_by_name("s3_datalake")

# Get by name with fields
svc = StorageServices.retrieve_by_name(
    "s3_datalake",
    fields=["owners", "tags", "domains"]
)
{
  "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.1,
  "updatedAt": 1769982621820,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106",
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

Retrieve a Storage Service

Get a single storage service by its unique ID or fully qualified name.

Get by ID

id
string
required
UUID of the storage service to retrieve.
fields
string
Comma-separated list of fields to include (e.g., owners,tags,domains).
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Fully Qualified Name

Use GET /v1/services/storageServices/name/{fqn} to retrieve by fully qualified name.
fqn
string
required
Fully qualified name of the storage service (e.g., s3_datalake).
fields
string
Comma-separated list of fields to include: owners, tags, domains.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /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"
)

# Get by ID
svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106")
print(f"{svc.fullyQualifiedName}: {svc.serviceType}")

# Get by ID with fields
svc = StorageServices.retrieve(
    "d1589e1d-2ab0-431c-a383-15e4be20a106",
    fields=["owners", "tags"]
)

# Get by fully qualified name
svc = StorageServices.retrieve_by_name("s3_datalake")

# Get by name with fields
svc = StorageServices.retrieve_by_name(
    "s3_datalake",
    fields=["owners", "tags", "domains"]
)
{
  "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.1,
  "updatedAt": 1769982621820,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106",
  "owners": [],
  "tags": [],
  "deleted": false,
  "domains": []
}

Returns

Returns a storage service object with all requested fields populated.

Response

id
string
Unique identifier for the storage service (UUID format).
name
string
Storage service name.
fullyQualifiedName
string
Fully qualified name of the service.
displayName
string
Human-readable display name.
description
string
Description of the storage service in Markdown format.
serviceType
string
Type of storage service (e.g., S3, GCS, ADLS, CustomStorage).
connection
object
Connection configuration for the service.
owners
array
List of owners. Only included when fields contains owners.
tags
array
Classification tags. Only included when fields contains tags.
domains
array
Domain assignments. Only included when fields contains domains.
version
number
Version number for the entity.

Error Handling

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