DELETE /v1/metrics/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Metrics

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

metric_id = "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10"

# Soft delete by ID.
Metrics.delete(metric_id)

# Restore a soft-deleted metric.
restored = Metrics.restore(metric_id)
print(restored.fullyQualifiedName)

# Permanently delete by ID.
Metrics.delete(metric_id, hard_delete=True)

import java.util.Map;

// client is an initialized OpenMetadataClient.
var metricId = "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10";

// Soft delete by ID.
client.metrics().delete(metricId);

// Restore a soft-deleted metric.
var restored = client.metrics().restore(metricId);
System.out.println(restored.getFullyQualifiedName());

// Permanently delete by ID.
client.metrics().delete(metricId, Map.of("hardDelete", "true"));

# Soft delete by ID.
curl -X DELETE \
  "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Hard delete by fully qualified name.
curl -X DELETE \
  "{base_url}/api/v1/metrics/name/customer_retention_rate?hardDelete=true" \
  -H "Authorization: Bearer {access_token}"

# Start an asynchronous soft delete.
curl -X DELETE \
  "{base_url}/api/v1/metrics/async/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Restore a soft-deleted metric.
curl -X PUT "{base_url}/api/v1/metrics/restore" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{"id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10"}'

{
  "id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "name": "customer_retention_rate",
  "displayName": "Customer Retention Rate",
  "fullyQualifiedName": "customer_retention_rate",
  "metricType": "RATIO",
  "unitOfMeasurement": "PERCENTAGE",
  "granularity": "MONTH",
  "version": 0.2,
  "updatedAt": 1787760600000,
  "updatedBy": "admin",
  "href": "https://your-company.open-metadata.org/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "deleted": true
}

{
  "jobId": "be87dcc9-cf29-4df0-a14e-bc80df332999",
  "message": "Delete operation initiated for customer_retention_rate",
  "entityName": "customer_retention_rate",
  "hardDelete": false,
  "recursive": false
}

DELETE

metrics

{id}

DELETE /v1/metrics/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Metrics

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

metric_id = "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10"

# Soft delete by ID.
Metrics.delete(metric_id)

# Restore a soft-deleted metric.
restored = Metrics.restore(metric_id)
print(restored.fullyQualifiedName)

# Permanently delete by ID.
Metrics.delete(metric_id, hard_delete=True)

import java.util.Map;

// client is an initialized OpenMetadataClient.
var metricId = "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10";

// Soft delete by ID.
client.metrics().delete(metricId);

// Restore a soft-deleted metric.
var restored = client.metrics().restore(metricId);
System.out.println(restored.getFullyQualifiedName());

// Permanently delete by ID.
client.metrics().delete(metricId, Map.of("hardDelete", "true"));

# Soft delete by ID.
curl -X DELETE \
  "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Hard delete by fully qualified name.
curl -X DELETE \
  "{base_url}/api/v1/metrics/name/customer_retention_rate?hardDelete=true" \
  -H "Authorization: Bearer {access_token}"

# Start an asynchronous soft delete.
curl -X DELETE \
  "{base_url}/api/v1/metrics/async/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Restore a soft-deleted metric.
curl -X PUT "{base_url}/api/v1/metrics/restore" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{"id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10"}'

{
  "id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "name": "customer_retention_rate",
  "displayName": "Customer Retention Rate",
  "fullyQualifiedName": "customer_retention_rate",
  "metricType": "RATIO",
  "unitOfMeasurement": "PERCENTAGE",
  "granularity": "MONTH",
  "version": 0.2,
  "updatedAt": 1787760600000,
  "updatedBy": "admin",
  "href": "https://your-company.open-metadata.org/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "deleted": true
}

{
  "jobId": "be87dcc9-cf29-4df0-a14e-bc80df332999",
  "message": "Delete operation initiated for customer_retention_rate",
  "entityName": "customer_retention_rate",
  "hardDelete": false,
  "recursive": false
}

Delete a Metric

Delete a metric by UUID or fully qualified name. By default, the API soft-deletes the metric for later restoration. A hard delete permanently removes it.

Delete by ID

string

required

UUID of the metric to delete.

boolean

default:"false"

Permanently delete the metric. If false, the metric is soft-deleted and can be restored.

Delete by Fully Qualified Name

Use DELETE /v1/metrics/name/{fqn} to delete by fully qualified name.

string

required

Fully qualified name of the metric, such as customer_retention_rate.

boolean

default:"false"

Permanently delete the metric.

Delete Asynchronously

Use DELETE /v1/metrics/async/{id} when deletion should run in the background. The endpoint accepts the same hardDelete query parameter and returns 202 Accepted with a job identifier.

Restore a Soft-Deleted Metric

Use PUT /v1/metrics/restore with the metric UUID in the request body.

string

required

UUID of the soft-deleted metric to restore.

DELETE /v1/metrics/{id}

from metadata.sdk import configure
from metadata.sdk.entities import Metrics

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

metric_id = "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10"

# Soft delete by ID.
Metrics.delete(metric_id)

# Restore a soft-deleted metric.
restored = Metrics.restore(metric_id)
print(restored.fullyQualifiedName)

# Permanently delete by ID.
Metrics.delete(metric_id, hard_delete=True)

import java.util.Map;

// client is an initialized OpenMetadataClient.
var metricId = "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10";

// Soft delete by ID.
client.metrics().delete(metricId);

// Restore a soft-deleted metric.
var restored = client.metrics().restore(metricId);
System.out.println(restored.getFullyQualifiedName());

// Permanently delete by ID.
client.metrics().delete(metricId, Map.of("hardDelete", "true"));

# Soft delete by ID.
curl -X DELETE \
  "{base_url}/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Hard delete by fully qualified name.
curl -X DELETE \
  "{base_url}/api/v1/metrics/name/customer_retention_rate?hardDelete=true" \
  -H "Authorization: Bearer {access_token}"

# Start an asynchronous soft delete.
curl -X DELETE \
  "{base_url}/api/v1/metrics/async/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10" \
  -H "Authorization: Bearer {access_token}"

# Restore a soft-deleted metric.
curl -X PUT "{base_url}/api/v1/metrics/restore" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{"id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10"}'

{
  "id": "b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "name": "customer_retention_rate",
  "displayName": "Customer Retention Rate",
  "fullyQualifiedName": "customer_retention_rate",
  "metricType": "RATIO",
  "unitOfMeasurement": "PERCENTAGE",
  "granularity": "MONTH",
  "version": 0.2,
  "updatedAt": 1787760600000,
  "updatedBy": "admin",
  "href": "https://your-company.open-metadata.org/api/v1/metrics/b8a9d6e4-2f7c-4f3a-9c1e-6d5b8a7f2e10",
  "deleted": true
}

{
  "jobId": "be87dcc9-cf29-4df0-a14e-bc80df332999",
  "message": "Delete operation initiated for customer_retention_rate",
  "entityName": "customer_retention_rate",
  "hardDelete": false,
  "recursive": false
}

Returns

The synchronous REST endpoints return the deleted metric. A soft-deleted metric has deleted: true. An asynchronous delete returns a job descriptor. Restore returns the restored metric. The Python and Java SDK delete methods do not return a value.

A hard-deleted metric cannot be restored.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	The metric is not soft-deleted when a restore is requested
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to delete or restore this metric
`404`	`NOT_FOUND`	Metric with the given ID or FQN does not exist

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Delete a Metric

Delete a Metric

Delete by ID

Delete by Fully Qualified Name

Delete Asynchronously

Restore a Soft-Deleted Metric

Returns

Error Handling