PUT /v1/apiCollections

curl -X PUT "{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"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import APICollections

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

# Retrieve, modify, and update
ac = APICollections.retrieve("0f7ee81c-8163-4097-8adb-45c3d6c7b14b")
ac.description = "Updated: Pet-related API endpoints for the Petstore service"
updated = APICollections.update(ac)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.APICollection;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
APICollection ac = client.apiCollections().get("0f7ee81c-8163-4097-8adb-45c3d6c7b14b");
ac.setDescription("Updated: Pet-related API endpoints for the Petstore service");
APICollection updated = client.apiCollections().update("0f7ee81c-8163-4097-8adb-45c3d6c7b14b", ac);

# Update by ID
curl -X PATCH "{base_url}/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Pet-related API endpoints for the Petstore service"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/apiCollections/name/sample_api_service.pet" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Pet-related API endpoints for the Petstore service"}
  ]'

{
  "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "name": "pet",
  "fullyQualifiedName": "sample_api_service.pet",
  "description": "Updated: Pet-related API endpoints for the Petstore service",
  "version": 0.2,
  "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": []
}

PUT

apiCollections

PUT /v1/apiCollections

curl -X PUT "{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"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import APICollections

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

# Retrieve, modify, and update
ac = APICollections.retrieve("0f7ee81c-8163-4097-8adb-45c3d6c7b14b")
ac.description = "Updated: Pet-related API endpoints for the Petstore service"
updated = APICollections.update(ac)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.APICollection;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
APICollection ac = client.apiCollections().get("0f7ee81c-8163-4097-8adb-45c3d6c7b14b");
ac.setDescription("Updated: Pet-related API endpoints for the Petstore service");
APICollection updated = client.apiCollections().update("0f7ee81c-8163-4097-8adb-45c3d6c7b14b", ac);

# Update by ID
curl -X PATCH "{base_url}/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Pet-related API endpoints for the Petstore service"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/apiCollections/name/sample_api_service.pet" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Pet-related API endpoints for the Petstore service"}
  ]'

{
  "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "name": "pet",
  "fullyQualifiedName": "sample_api_service.pet",
  "description": "Updated: Pet-related API endpoints for the Petstore service",
  "version": 0.2,
  "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": []
}

Update an API Collection

Create an API collection or update it if it already exists, using PUT /v1/apiCollections with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

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.

PUT /v1/apiCollections

curl -X PUT "{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"
  }'

from metadata.sdk import configure
from metadata.sdk.entities import APICollections

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

# Retrieve, modify, and update
ac = APICollections.retrieve("0f7ee81c-8163-4097-8adb-45c3d6c7b14b")
ac.description = "Updated: Pet-related API endpoints for the Petstore service"
updated = APICollections.update(ac)

print(f"Updated to version {updated.version.root}")

import org.openmetadata.schema.entity.data.APICollection;

// client is an initialized OpenMetadataClient.

// Retrieve, modify, and update
APICollection ac = client.apiCollections().get("0f7ee81c-8163-4097-8adb-45c3d6c7b14b");
ac.setDescription("Updated: Pet-related API endpoints for the Petstore service");
APICollection updated = client.apiCollections().update("0f7ee81c-8163-4097-8adb-45c3d6c7b14b", ac);

# Update by ID
curl -X PATCH "{base_url}/api/v1/apiCollections/0f7ee81c-8163-4097-8adb-45c3d6c7b14b" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Pet-related API endpoints for the Petstore service"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/apiCollections/name/sample_api_service.pet" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Pet-related API endpoints for the Petstore service"}
  ]'

{
  "id": "0f7ee81c-8163-4097-8adb-45c3d6c7b14b",
  "name": "pet",
  "fullyQualifiedName": "sample_api_service.pet",
  "description": "Updated: Pet-related API endpoints for the Petstore service",
  "version": 0.2,
  "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 updated API collection object with the new version number.

Response

string

Unique identifier for the API collection (UUID format).

string

API collection name.

string

Fully qualified name in format service.collectionName.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this API collection
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update an API Collection

Update an API Collection

Body Parameters

Returns

Response

Error Handling