List Storage Services

List all storage services with optional filtering and pagination

GET /v1/services/storageServices

GET /v1/services/storageServices

Python

from metadata.sdk import configure
from metadata.sdk.entities import StorageServices

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# List first page
services = StorageServices.list(limit=50)
for svc in services.data:
    print(f"{svc.fullyQualifiedName} ({svc.serviceType})")

# List all with auto-pagination
for svc in StorageServices.list_all():
    print(f"{svc.fullyQualifiedName}")

# List with fields
services = StorageServices.list(
    fields=["owners", "tags", "domains"],
    limit=50
)

for svc in services.data:
    print(f"{svc.fullyQualifiedName}")
    if svc.owners:
        print(f"  Owners: {[o.name for o in svc.owners]}")

Response

{
  "data": [
    {
      "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": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

List Storage Services

List all storage services with optional filtering and pagination.

Query Parameters

limit · integer · default: "10"

Maximum number of results to return (max: 1000000).

before · string

Cursor for backward pagination.

after · string

Cursor for forward pagination.

fields · string

Comma-separated list of fields to include: owners, tags, domains. See Supported Fields below.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

GET /v1/services/storageServices

Python

from metadata.sdk import configure
from metadata.sdk.entities import StorageServices

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# List first page
services = StorageServices.list(limit=50)
for svc in services.data:
    print(f"{svc.fullyQualifiedName} ({svc.serviceType})")

# List all with auto-pagination
for svc in StorageServices.list_all():
    print(f"{svc.fullyQualifiedName}")

# List with fields
services = StorageServices.list(
    fields=["owners", "tags", "domains"],
    limit=50
)

for svc in services.data:
    print(f"{svc.fullyQualifiedName}")
    if svc.owners:
        print(f"  Owners: {[o.name for o in svc.owners]}")

Response

{
  "data": [
    {
      "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": []
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

---

Returns

Returns a paginated list of storage service objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data · array

Array of storage service objects.

Show properties

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.

serviceType · string

Type of storage service (e.g., S3, GCS, ADLS, CustomStorage).

connection · object

Connection configuration for the service.

owners · array

List of owners assigned to the storage service. Only included when fields contains owners.

tags · array

Classification tags applied. Only included when fields contains tags.

domains · array

Domain assignments for governance. Only included when fields contains domains.

paging · object

Pagination information.

Show properties

total · integer

Total count of storage services matching the query.

after · string

Cursor for the next page of results. Null if this is the last page.

before · string

Cursor for the previous page of results. Null if this is the first page.

---

Supported Fields

The following fields can be requested via the fields query parameter:

Field	Description
owners	Owner references (users and teams)
tags	Classification tags
domains	Domain assignments for governance

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to list storage services