GET /v1/services/storageServices
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]}")
import static org.openmetadata.sdk.fluent.StorageServices.*;
// List first page
var result = StorageServices.list()
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
// List with fields
var result = StorageServices.list()
.fields("owners", "tags", "domains")
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/services/storageServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/storageServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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
GET
/
v1
/
services
/
storageServices
GET /v1/services/storageServices
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]}")
import static org.openmetadata.sdk.fluent.StorageServices.*;
// List first page
var result = StorageServices.list()
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
// List with fields
var result = StorageServices.list()
.fields("owners", "tags", "domains")
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/services/storageServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/storageServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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
Maximum number of results to return (max: 1000000).
Cursor for backward pagination.
Cursor for forward pagination.
Comma-separated list of fields to include:
owners, tags, domains. See Supported Fields below.Include
all, deleted, or non-deleted entities.GET /v1/services/storageServices
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]}")
import static org.openmetadata.sdk.fluent.StorageServices.*;
// List first page
var result = StorageServices.list()
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
// List with fields
var result = StorageServices.list()
.fields("owners", "tags", "domains")
.limit(50)
.execute();
for (var svc : result.getData()) {
System.out.println(svc.getFullyQualifiedName());
}
# List all
curl "{base_url}/api/v1/services/storageServices?limit=50" \
-H "Authorization: Bearer {access_token}"
# With fields
curl "{base_url}/api/v1/services/storageServices?fields=owners,tags,domains&limit=50" \
-H "Authorization: Bearer {access_token}"
{
"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 thefields parameter to request additional data.
Response
Array of storage service objects.
Show properties
Show properties
Unique identifier for the storage service (UUID format).
Storage service name.
Fully qualified name of the service.
Human-readable display name.
Type of storage service (e.g., S3, GCS, ADLS, CustomStorage).
Connection configuration for the service.
List of owners assigned to the storage service. Only included when
fields contains owners.Classification tags applied. Only included when
fields contains tags.Domain assignments for governance. Only included when
fields contains domains.Supported Fields
The following fields can be requested via thefields 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 |
Was this page helpful?
⌘I