Skip to main content
Infrastructure/Metrics Catalog

ArchiveMetric

Archive a metric definition, removing it from active use while retaining history.

POST/api/v1/metrics/{id}/archive

Operation ID

ArchiveMetric

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • id
    StringRequired

    Unique identifier of the metric to archive

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • data
    Object

    The data value

    Example: (nested object)