Skip to main content
ZStack
Infrastructure/Metrics Catalog

DeletePolicy

Delete a retention policy from the system.

DELETE/api/v1/metrics/retention-policies/{id}

Operation ID

DeletePolicy

Since

1.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 retention policy to delete

Query Parameters

  • options.propagationPolicy
    String

    PropagationPolicy overrides the resource's default policy when non-empty. Accepted values: Restrict, Foreground, Background, Orphan, SoftDelete.

  • options.force
    Boolean

    Force skips the Finalizer phase and advances directly to PhysicalDelete. Requires operator-level permission; returns PermissionDenied until the audit-integration rollout lands.

    Example: true

  • options.gracePeriodSeconds
    Integer

    GracePeriodSeconds defines the post-request delay before the engine begins the Checking phase. Default 0 (immediate).

    Example: 0

  • options.revokeRemoteCredentials
    Boolean

    RevokeRemoteCredentials is a resource-scoped hint for resources that carry out-of-band credentials (e.g. Platform access keys). When true, the corresponding revoke finalizer is activated for this request. Ignored by resources that do not register such a finalizer.

    Example: true

Responses

200 OK

DELETE endpoints return an empty object on success, or a standard error structure on failure.

Success Response

{}

Error Response

{
  "error": {
    "code": "SYS.1001",
    "description": "A message or a operation timeout",
    "details": "Delete resource timeout after 300s"
  }
}

Change History

This API has no change history records yet.

View all change history