GET /v1/services/storageServices/{id}

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"
)

# 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"]
)

import static org.openmetadata.sdk.fluent.StorageServices.*;

// Get by ID
var svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");

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

// Get by fully qualified name
var svc = StorageServices.retrieveByName("s3_datalake");

// Get by name with fields
var svc = StorageServices.retrieveByName("s3_datalake", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/storageServices/name/s3_datalake" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/storageServices/name/s3_datalake?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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": []
}

GET

services

storageServices

{id}

GET /v1/services/storageServices/{id}

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"
)

# 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"]
)

import static org.openmetadata.sdk.fluent.StorageServices.*;

// Get by ID
var svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");

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

// Get by fully qualified name
var svc = StorageServices.retrieveByName("s3_datalake");

// Get by name with fields
var svc = StorageServices.retrieveByName("s3_datalake", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/storageServices/name/s3_datalake" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/storageServices/name/s3_datalake?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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

string

required

UUID of the storage service to retrieve.

string

Comma-separated list of fields to include (e.g., owners,tags,domains).

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.

string

required

Fully qualified name of the storage service (e.g., s3_datalake).

string

Comma-separated list of fields to include: owners, tags, domains.

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.open-metadata.org/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"]
)

import static org.openmetadata.sdk.fluent.StorageServices.*;

// Get by ID
var svc = StorageServices.retrieve("d1589e1d-2ab0-431c-a383-15e4be20a106");

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

// Get by fully qualified name
var svc = StorageServices.retrieveByName("s3_datalake");

// Get by name with fields
var svc = StorageServices.retrieveByName("s3_datalake", "owners,tags,domains");

# Get by ID
curl "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106" \
  -H "Authorization: Bearer {access_token}"

# Get by ID with fields
curl "{base_url}/api/v1/services/storageServices/d1589e1d-2ab0-431c-a383-15e4be20a106?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

# Get by fully qualified name
curl "{base_url}/api/v1/services/storageServices/name/s3_datalake" \
  -H "Authorization: Bearer {access_token}"

# Get by name with fields
curl "{base_url}/api/v1/services/storageServices/name/s3_datalake?fields=owners,tags,domains" \
  -H "Authorization: Bearer {access_token}"

{
  "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

string

Unique identifier for the storage service (UUID format).

string

Storage service name.

string

Fully qualified name of the service.

string

Human-readable display name.

string

Description of the storage service in Markdown format.

string

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

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

array

List of owners. Only included when fields contains owners.

array

Classification tags. Only included when fields contains tags.

array

Domain assignments. Only included when fields contains domains.

number

Version number for the entity.

Error Handling

Code	Error Type	Description
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to view this storage service
`404`	`NOT_FOUND`	Storage service with given ID or FQN does not exist

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Retrieve a Storage Service

Retrieve a Storage Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling

​Retrieve a Storage Service

​Get by ID

​Get by Fully Qualified Name

​Returns

​Response

​Error Handling

Retrieve a Storage Service

Get by ID

Get by Fully Qualified Name

Returns

Response

Error Handling