POST /v1/services/storageServices

from metadata.sdk import configure
from metadata.sdk.entities import StorageServices
from metadata.generated.schema.api.services.createStorageService import CreateStorageServiceRequest

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

request = CreateStorageServiceRequest(
    name="s3_datalake",
    displayName="S3 Data Lake",
    serviceType="S3",
    description="Production S3 data lake for analytics",
    connection={
        "config": {
            "type": "S3",
            "awsConfig": {
                "awsAccessKeyId": "AKIA...",
                "awsSecretAccessKey": "***",
                "awsRegion": "us-east-1",
                "endPointURL": "https://s3.amazonaws.com/"
            }
        }
    }
)

service = StorageServices.create(request)
print(f"Created: {service.fullyQualifiedName.root}")

import org.openmetadata.schema.api.services.CreateStorageService;
import org.openmetadata.schema.api.services.CreateStorageService.StorageServiceType;
import org.openmetadata.schema.entity.services.StorageService;
import org.openmetadata.schema.security.credentials.AWSCredentials;
import org.openmetadata.schema.services.connections.storage.S3Connection;
import org.openmetadata.schema.type.StorageConnection;
import org.openmetadata.sdk.fluent.StorageServices;

// client is an initialized OpenMetadataClient.
StorageServices.setDefaultClient(client);

CreateStorageService request = new CreateStorageService()
    .withName("s3_datalake")
    .withServiceType(StorageServiceType.S3)
    .withConnection(new StorageConnection().withConfig(
        new S3Connection().withAwsConfig(
            new AWSCredentials()
                .withAwsAccessKeyId("AKIA...")
                .withAwsSecretAccessKey("***")
                .withAwsRegion("us-east-1"))));

StorageService service = StorageServices.create(request);

curl -X POST "{base_url}/api/v1/services/storageServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "s3_datalake",
    "serviceType": "S3",
    "description": "Production S3 data lake for analytics",
    "connection": {
      "config": {
        "type": "S3",
        "awsConfig": {
          "awsAccessKeyId": "AKIA...",
          "awsSecretAccessKey": "***",
          "awsRegion": "us-east-1",
          "endPointURL": "https://s3.amazonaws.com/"
        }
      }
    }
  }'

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

POST

services

storageServices

POST /v1/services/storageServices

from metadata.sdk import configure
from metadata.sdk.entities import StorageServices
from metadata.generated.schema.api.services.createStorageService import CreateStorageServiceRequest

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

request = CreateStorageServiceRequest(
    name="s3_datalake",
    displayName="S3 Data Lake",
    serviceType="S3",
    description="Production S3 data lake for analytics",
    connection={
        "config": {
            "type": "S3",
            "awsConfig": {
                "awsAccessKeyId": "AKIA...",
                "awsSecretAccessKey": "***",
                "awsRegion": "us-east-1",
                "endPointURL": "https://s3.amazonaws.com/"
            }
        }
    }
)

service = StorageServices.create(request)
print(f"Created: {service.fullyQualifiedName.root}")

import org.openmetadata.schema.api.services.CreateStorageService;
import org.openmetadata.schema.api.services.CreateStorageService.StorageServiceType;
import org.openmetadata.schema.entity.services.StorageService;
import org.openmetadata.schema.security.credentials.AWSCredentials;
import org.openmetadata.schema.services.connections.storage.S3Connection;
import org.openmetadata.schema.type.StorageConnection;
import org.openmetadata.sdk.fluent.StorageServices;

// client is an initialized OpenMetadataClient.
StorageServices.setDefaultClient(client);

CreateStorageService request = new CreateStorageService()
    .withName("s3_datalake")
    .withServiceType(StorageServiceType.S3)
    .withConnection(new StorageConnection().withConfig(
        new S3Connection().withAwsConfig(
            new AWSCredentials()
                .withAwsAccessKeyId("AKIA...")
                .withAwsSecretAccessKey("***")
                .withAwsRegion("us-east-1"))));

StorageService service = StorageServices.create(request);

curl -X POST "{base_url}/api/v1/services/storageServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "s3_datalake",
    "serviceType": "S3",
    "description": "Production S3 data lake for analytics",
    "connection": {
      "config": {
        "type": "S3",
        "awsConfig": {
          "awsAccessKeyId": "AKIA...",
          "awsSecretAccessKey": "***",
          "awsRegion": "us-east-1",
          "endPointURL": "https://s3.amazonaws.com/"
        }
      }
    }
  }'

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

Create a Storage Service

Create a new storage service connection to a platform such as S3, GCS, or ADLS.

Body Parameters

string

required

Name of the storage service. Must be unique across all storage services.

string

required

Type of storage service, for example S3, GCS, ADLS, CustomStorage.

object

required

Connection configuration specific to the service type.

Show properties

object

Service-specific connection configuration, such as AWS credentials for S3 and project ID for GCS.

string

Human-readable display name for the storage service.

string

Description of the storage service in Markdown format.

array

Array of owner references (users or teams) to assign to the service.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Fully qualified names of the domains to assign for governance purposes.

array

Array of classification tags to apply to the storage service.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

POST /v1/services/storageServices

from metadata.sdk import configure
from metadata.sdk.entities import StorageServices
from metadata.generated.schema.api.services.createStorageService import CreateStorageServiceRequest

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

request = CreateStorageServiceRequest(
    name="s3_datalake",
    displayName="S3 Data Lake",
    serviceType="S3",
    description="Production S3 data lake for analytics",
    connection={
        "config": {
            "type": "S3",
            "awsConfig": {
                "awsAccessKeyId": "AKIA...",
                "awsSecretAccessKey": "***",
                "awsRegion": "us-east-1",
                "endPointURL": "https://s3.amazonaws.com/"
            }
        }
    }
)

service = StorageServices.create(request)
print(f"Created: {service.fullyQualifiedName.root}")

import org.openmetadata.schema.api.services.CreateStorageService;
import org.openmetadata.schema.api.services.CreateStorageService.StorageServiceType;
import org.openmetadata.schema.entity.services.StorageService;
import org.openmetadata.schema.security.credentials.AWSCredentials;
import org.openmetadata.schema.services.connections.storage.S3Connection;
import org.openmetadata.schema.type.StorageConnection;
import org.openmetadata.sdk.fluent.StorageServices;

// client is an initialized OpenMetadataClient.
StorageServices.setDefaultClient(client);

CreateStorageService request = new CreateStorageService()
    .withName("s3_datalake")
    .withServiceType(StorageServiceType.S3)
    .withConnection(new StorageConnection().withConfig(
        new S3Connection().withAwsConfig(
            new AWSCredentials()
                .withAwsAccessKeyId("AKIA...")
                .withAwsSecretAccessKey("***")
                .withAwsRegion("us-east-1"))));

StorageService service = StorageServices.create(request);

curl -X POST "{base_url}/api/v1/services/storageServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "s3_datalake",
    "serviceType": "S3",
    "description": "Production S3 data lake for analytics",
    "connection": {
      "config": {
        "type": "S3",
        "awsConfig": {
          "awsAccessKeyId": "AKIA...",
          "awsSecretAccessKey": "***",
          "awsRegion": "us-east-1",
          "endPointURL": "https://s3.amazonaws.com/"
        }
      }
    }
  }'

{
  "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 the created storage service object with all specified properties and system-generated fields.

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, for example S3, GCS, ADLS, CustomStorage.

object

Connection configuration for the service.

Show properties

object

Service-specific connection configuration.

array

List of owners assigned to the storage service.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Fully qualified names of the assigned domains.

array

Classification tags applied to the storage service.

Show properties

string

Fully qualified name of the tag.

string

Type of label, for example Manual, Derived, Propagated.

string

State of the tag, for example Suggested, Confirmed.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

Use PUT /v1/services/storageServices instead of POST to perform an upsert. If a storage service with the same fullyQualifiedName already exists, it will be updated; otherwise, a new service is created. The request body is the same as POST.

curl -X PUT "{base_url}/api/v1/services/storageServices" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{ ... same body as POST ... }'

Note: PUT will not return a 409 conflict error if the entity already exists — it will update the existing entity instead. However, for certain fields (such as description, tags, owners, and custom properties), PUT preserves an already-populated value instead of overwriting it with an empty or omitted one — the exact behavior depends on the field and the calling user or bot’s permissions, not a blanket rule. See Entity Update Behavior for the full preserve/merge rules. Use PATCH to intentionally replace an existing value.

Bulk Create or Update (PUT)

Use PUT /v1/services/storageServices/bulk to create or update multiple storage services in a single request. The request body is an array of create request objects.

curl -X PUT "{base_url}/api/v1/services/storageServices/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "s3_datalake", "serviceType": "S3", "connection": { "config": {} } },
    { "name": "gcs_analytics", "serviceType": "GCS", "connection": { "config": {} } }
  ]'

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid request body or missing required fields
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to create storage services
`409`	`ENTITY_ALREADY_EXISTS`	Storage service with same name already exists (POST only)

API Reference

SDK

API

Data Assets

AI Assets

Discovery

Lineage

Data Contracts

Teams & Users

Data Governance

Data Quality

Alerts

Incidents

Billing

Query Runner

Context Plugins

Standards

Create a Storage Service

Create a Storage Service

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling