PATCH /v1/apiEndpoints/{id}

from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

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

# Retrieve, modify, and update
ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c")
ep.description = "Updated: Add a new pet to the store inventory"
updated = APIEndpoints.update(ep)

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

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

// Retrieve, modify, and update
var ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c");
ep.setDescription("Updated: Add a new pet to the store inventory");
var updated = APIEndpoints.update(ep);

# Update by ID
curl -X PATCH "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Add a new pet to the store inventory"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Add a new pet to the store inventory"}
  ]'

{
  "id": "1f61427a-4a64-4070-9ac8-1d29302dac7c",
  "name": "addPet",
  "displayName": "Add Pet",
  "fullyQualifiedName": "sample_api_service.pet.addPet",
  "description": "Updated: Add a new pet to the store inventory",
  "version": 0.2,
  "updatedAt": 1769982733987,
  "updatedBy": "admin",
  "endpointURL": "https://petstore3.swagger.io/#/pet/addPet",
  "requestMethod": "POST",
  "requestSchema": {
    "schemaType": "JSON",
    "schemaFields": [
      {"name": "id", "dataType": "INT", "description": "ID of pet"}
    ]
  },
  "href": "http://localhost:8585/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c",
  "owners": [],
  "tags": [],
  "service": {
    "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
    "type": "apiService",
    "name": "sample_api_service",
    "deleted": false
  },
  "serviceType": "Rest",
  "deleted": false,
  "domains": []
}

PATCH

apiEndpoints

{id}

PATCH /v1/apiEndpoints/{id}

from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

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

# Retrieve, modify, and update
ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c")
ep.description = "Updated: Add a new pet to the store inventory"
updated = APIEndpoints.update(ep)

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

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

// Retrieve, modify, and update
var ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c");
ep.setDescription("Updated: Add a new pet to the store inventory");
var updated = APIEndpoints.update(ep);

# Update by ID
curl -X PATCH "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Add a new pet to the store inventory"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Add a new pet to the store inventory"}
  ]'

{
  "id": "1f61427a-4a64-4070-9ac8-1d29302dac7c",
  "name": "addPet",
  "displayName": "Add Pet",
  "fullyQualifiedName": "sample_api_service.pet.addPet",
  "description": "Updated: Add a new pet to the store inventory",
  "version": 0.2,
  "updatedAt": 1769982733987,
  "updatedBy": "admin",
  "endpointURL": "https://petstore3.swagger.io/#/pet/addPet",
  "requestMethod": "POST",
  "requestSchema": {
    "schemaType": "JSON",
    "schemaFields": [
      {"name": "id", "dataType": "INT", "description": "ID of pet"}
    ]
  },
  "href": "http://localhost:8585/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c",
  "owners": [],
  "tags": [],
  "service": {
    "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
    "type": "apiService",
    "name": "sample_api_service",
    "deleted": false
  },
  "serviceType": "Rest",
  "deleted": false,
  "domains": []
}

Update an API Endpoint

Update an API endpoint’s properties using JSON Merge Patch. You can update by ID or by fully qualified name.

Update by ID

string

required

UUID of the API endpoint to update.

Update by Name

Use PATCH /v1/apiEndpoints/name/{fqn} to update by fully qualified name.

string

required

Fully qualified name of the API endpoint (e.g., sample_api_service.pet.addPet).

Body Parameters

Send a JSON object with the fields to update. Only provided fields are changed.

string

Updated description in Markdown format.

string

Updated display name.

string

Updated URL for the API endpoint.

string

Updated HTTP request method: GET, POST, PUT, PATCH, or DELETE.

object

Updated request body schema.

Show properties

string

Type of schema (e.g., JSON).

array

Array of field objects describing the schema.

object

Updated response body schema.

Show properties

string

Type of schema (e.g., JSON).

array

Array of field objects describing the schema.

array

Updated list of owner references.

Show properties

string

UUID of the owner entity.

string

Type of owner entity (e.g., user, team).

array

Updated classification tags.

Show properties

string

required

Fully qualified name of the tag.

string

Type of label (e.g., Manual, Derived, Propagated).

string

State of the tag (e.g., Suggested, Confirmed).

string

Updated domain FQN.

object

Updated custom property values.

PATCH /v1/apiEndpoints/{id}

from metadata.sdk import configure
from metadata.sdk.entities import APIEndpoints

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

# Retrieve, modify, and update
ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c")
ep.description = "Updated: Add a new pet to the store inventory"
updated = APIEndpoints.update(ep)

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

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

// Retrieve, modify, and update
var ep = APIEndpoints.retrieve("1f61427a-4a64-4070-9ac8-1d29302dac7c");
ep.setDescription("Updated: Add a new pet to the store inventory");
var updated = APIEndpoints.update(ep);

# Update by ID
curl -X PATCH "{base_url}/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Add a new pet to the store inventory"}
  ]'

# Update by name
curl -X PATCH "{base_url}/api/v1/apiEndpoints/name/sample_api_service.pet.addPet" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Add a new pet to the store inventory"}
  ]'

{
  "id": "1f61427a-4a64-4070-9ac8-1d29302dac7c",
  "name": "addPet",
  "displayName": "Add Pet",
  "fullyQualifiedName": "sample_api_service.pet.addPet",
  "description": "Updated: Add a new pet to the store inventory",
  "version": 0.2,
  "updatedAt": 1769982733987,
  "updatedBy": "admin",
  "endpointURL": "https://petstore3.swagger.io/#/pet/addPet",
  "requestMethod": "POST",
  "requestSchema": {
    "schemaType": "JSON",
    "schemaFields": [
      {"name": "id", "dataType": "INT", "description": "ID of pet"}
    ]
  },
  "href": "http://localhost:8585/api/v1/apiEndpoints/1f61427a-4a64-4070-9ac8-1d29302dac7c",
  "owners": [],
  "tags": [],
  "service": {
    "id": "58d413a8-abc3-4a6d-bd8a-13a0234b1ff8",
    "type": "apiService",
    "name": "sample_api_service",
    "deleted": false
  },
  "serviceType": "Rest",
  "deleted": false,
  "domains": []
}

Returns

Returns the updated API endpoint object with the new version number.

Response

string

Unique identifier for the API endpoint (UUID format).

string

API endpoint name.

string

Fully qualified name in format service.collection.endpointName.

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid JSON patch or malformed request
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this API endpoint
`404`	`NOT_FOUND`	API endpoint with given ID or FQN does not exist
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Update an API Endpoint

Update an API Endpoint

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling

​Update an API Endpoint

​Update by ID

​Update by Name

​Body Parameters

​Returns

​Response

​Error Handling

Update an API Endpoint

Update by ID

Update by Name

Body Parameters

Returns

Response

Error Handling