> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an API Endpoint

> Update API endpoint properties using JSON Patch

# 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

<ParamField path="id" type="string" required>
  UUID of the API endpoint to update.
</ParamField>

## Update by Name

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

<ParamField path="fqn" type="string" required>
  Fully qualified name of the API endpoint (e.g., `sample_api_service.pet.addPet`).
</ParamField>

## Body Parameters

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

<ParamField body="description" type="string">
  Updated description in Markdown format.
</ParamField>

<ParamField body="displayName" type="string">
  Updated display name.
</ParamField>

<ParamField body="endpointURL" type="string">
  Updated URL for the API endpoint.
</ParamField>

<ParamField body="requestMethod" type="string">
  Updated HTTP request method: `GET`, `POST`, `PUT`, `PATCH`, or `DELETE`.
</ParamField>

<ParamField body="requestSchema" type="object">
  Updated request body schema.

  <Expandable title="properties">
    <ParamField body="schemaType" type="string">
      Type of schema (e.g., `JSON`).
    </ParamField>

    <ParamField body="schemaFields" type="array">
      Array of field objects describing the schema.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="responseSchema" type="object">
  Updated response body schema.

  <Expandable title="properties">
    <ParamField body="schemaType" type="string">
      Type of schema (e.g., `JSON`).
    </ParamField>

    <ParamField body="schemaFields" type="array">
      Array of field objects describing the schema.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="owners" type="array">
  Updated list of owner references.

  <Expandable title="properties">
    <ParamField body="id" type="string">
      UUID of the owner entity.
    </ParamField>

    <ParamField body="type" type="string">
      Type of owner entity (e.g., `user`, `team`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="tags" type="array">
  Updated classification tags.

  <Expandable title="properties">
    <ParamField body="tagFQN" type="string" required>
      Fully qualified name of the tag.
    </ParamField>

    <ParamField body="labelType" type="string">
      Type of label (e.g., `Manual`, `Derived`, `Propagated`).
    </ParamField>

    <ParamField body="state" type="string">
      State of the tag (e.g., `Suggested`, `Confirmed`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="domain" type="string">
  Updated domain FQN.
</ParamField>

<ParamField body="extension" type="object">
  Updated custom property values.
</ParamField>

<RequestExample dropdown>
  ```python PATCH /v1/apiEndpoints/{id} theme={null}
  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}")
  ```

  ```java PATCH /v1/apiEndpoints/{id} theme={null}
  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);
  ```

  ```bash PATCH /v1/apiEndpoints/{id} theme={null}
  # 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"}
    ]'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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": []
  }
  ```
</ResponseExample>

***

## Returns

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

## Response

<ResponseField name="id" type="string">
  Unique identifier for the API endpoint (UUID format).
</ResponseField>

<ResponseField name="name" type="string">
  API endpoint name.
</ResponseField>

<ResponseField name="fullyQualifiedName" type="string">
  Fully qualified name in format `service.collection.endpointName`.
</ResponseField>

<ResponseField name="description" type="string">
  Updated description.
</ResponseField>

<ResponseField name="version" type="number">
  Incremented version number.
</ResponseField>

***

## 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                  |