POST /v1/apiCollections

from metadata.sdk import configure
from metadata.sdk.entities import APICollections
from metadata.generated.schema.api.data.createAPICollection import CreateAPICollectionRequest

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

request = CreateAPICollectionRequest(
    name="pet",
    service="sample_api_service",
    endpointURL="https://petstore3.swagger.io/#/pet",
    description="Pet-related API endpoints"
)

api_collection = APICollections.create(request)
print(f"Created: {api_collection.fullyQualifiedName.root}")

import java.net.URI;
import org.openmetadata.schema.api.data.CreateAPICollection;
import org.openmetadata.schema.entity.data.APICollection;

// client is an initialized OpenMetadataClient.

CreateAPICollection request = new CreateAPICollection()
    .withName("pet")
    .withService("sample_api_service")
    .withEndpointURL(URI.create("https://petstore3.swagger.io/#/pet"))
    .withDescription("Pet-related API endpoints");

APICollection apiCollection = client.apiCollections().create(request);

curl -X POST "{base_url}/api/v1/apiCollections" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pet",
    "service": "sample_api_service",
    "endpointURL": "https://petstore3.swagger.io/#/pet",
    "description": "Pet-related API endpoints"
  }'

{
  "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "name": "pet",
  "fullyQualifiedName": "sample_api_service.pet",
  "version": 0.1,
  "updatedAt": 1769982733673,
  "updatedBy": "admin",
  "endpointURL": "https://petstore3.swagger.io/#/pet",
  "href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "owners": [],
  "tags": [],
  "service": {
    "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
    "type": "apiService",
    "name": "sample_api_service",
    "fullyQualifiedName": "sample_api_service",
    "deleted": false
  },
  "serviceType": "Rest",
  "deleted": false,
  "domains": []
}

POST

apiCollections

POST /v1/apiCollections

from metadata.sdk import configure
from metadata.sdk.entities import APICollections
from metadata.generated.schema.api.data.createAPICollection import CreateAPICollectionRequest

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

request = CreateAPICollectionRequest(
    name="pet",
    service="sample_api_service",
    endpointURL="https://petstore3.swagger.io/#/pet",
    description="Pet-related API endpoints"
)

api_collection = APICollections.create(request)
print(f"Created: {api_collection.fullyQualifiedName.root}")

import java.net.URI;
import org.openmetadata.schema.api.data.CreateAPICollection;
import org.openmetadata.schema.entity.data.APICollection;

// client is an initialized OpenMetadataClient.

CreateAPICollection request = new CreateAPICollection()
    .withName("pet")
    .withService("sample_api_service")
    .withEndpointURL(URI.create("https://petstore3.swagger.io/#/pet"))
    .withDescription("Pet-related API endpoints");

APICollection apiCollection = client.apiCollections().create(request);

curl -X POST "{base_url}/api/v1/apiCollections" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pet",
    "service": "sample_api_service",
    "endpointURL": "https://petstore3.swagger.io/#/pet",
    "description": "Pet-related API endpoints"
  }'

{
  "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "name": "pet",
  "fullyQualifiedName": "sample_api_service.pet",
  "version": 0.1,
  "updatedAt": 1769982733673,
  "updatedBy": "admin",
  "endpointURL": "https://petstore3.swagger.io/#/pet",
  "href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "owners": [],
  "tags": [],
  "service": {
    "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
    "type": "apiService",
    "name": "sample_api_service",
    "fullyQualifiedName": "sample_api_service",
    "deleted": false
  },
  "serviceType": "Rest",
  "deleted": false,
  "domains": []
}

Create an API Collection

Create a new API collection within an API service.

Body Parameters

string

required

Name of the API collection. Must be unique within the parent API service.

string

required

Fully qualified name of the parent APIService, for example sample_api_service.

string

Base URL for the API collection, for example https://petstore3.swagger.io/#/pet.

string

Human-readable display name for the API collection.

string

Description of the API collection in Markdown format.

array

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

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 API collection.

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.

object

Custom property values defined by your organization’s metadata schema.

POST /v1/apiCollections

from metadata.sdk import configure
from metadata.sdk.entities import APICollections
from metadata.generated.schema.api.data.createAPICollection import CreateAPICollectionRequest

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

request = CreateAPICollectionRequest(
    name="pet",
    service="sample_api_service",
    endpointURL="https://petstore3.swagger.io/#/pet",
    description="Pet-related API endpoints"
)

api_collection = APICollections.create(request)
print(f"Created: {api_collection.fullyQualifiedName.root}")

import java.net.URI;
import org.openmetadata.schema.api.data.CreateAPICollection;
import org.openmetadata.schema.entity.data.APICollection;

// client is an initialized OpenMetadataClient.

CreateAPICollection request = new CreateAPICollection()
    .withName("pet")
    .withService("sample_api_service")
    .withEndpointURL(URI.create("https://petstore3.swagger.io/#/pet"))
    .withDescription("Pet-related API endpoints");

APICollection apiCollection = client.apiCollections().create(request);

curl -X POST "{base_url}/api/v1/apiCollections" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "pet",
    "service": "sample_api_service",
    "endpointURL": "https://petstore3.swagger.io/#/pet",
    "description": "Pet-related API endpoints"
  }'

{
  "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "name": "pet",
  "fullyQualifiedName": "sample_api_service.pet",
  "version": 0.1,
  "updatedAt": 1769982733673,
  "updatedBy": "admin",
  "endpointURL": "https://petstore3.swagger.io/#/pet",
  "href": "http://localhost:8585/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "owners": [],
  "tags": [],
  "service": {
    "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
    "type": "apiService",
    "name": "sample_api_service",
    "fullyQualifiedName": "sample_api_service",
    "deleted": false
  },
  "serviceType": "Rest",
  "deleted": false,
  "domains": []
}

Returns

Returns the created API collection object with all specified properties and system-generated fields.

Response

string

Unique identifier for the API collection (UUID format).

string

API collection name.

string

Fully qualified name in format service.collectionName.

string

Human-readable display name.

string

Description of the API collection in Markdown format.

string

Base URL for the API collection.

object

Reference to the parent API service.

Show properties

string

UUID of the API service.

string

Type of entity (always apiService).

string

Name of the API service.

string

Fully qualified name of the API service.

string

Type of API service, for example Rest.

array

List of owners assigned to the API collection.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Domain assignments for governance.

array

Classification tags applied to the API collection.

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.

object

Custom property values defined by your organization’s metadata schema.

number

Version number for the entity (starts at 0.1).

Create or Update (PUT)

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

curl -X PUT "{base_url}/api/v1/apiCollections" \
  -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/apiCollections/bulk to create or update multiple API collections in a single request. The request body is an array of create request objects.

curl -X PUT "{base_url}/api/v1/apiCollections/bulk" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '[
    { "name": "pet", "service": "sample_api_service" },
    { "name": "store", "service": "sample_api_service" }
  ]'

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 API collections
`409`	`ENTITY_ALREADY_EXISTS`	API collection with same name already exists in service (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 an API Collection

Create an API Collection

Body Parameters

Returns

Response

Create or Update (PUT)

Bulk Create or Update (PUT)

Error Handling