Skip to main content
ZStack
Infrastructure/Resource Deletion

DeleteResource

Delete a resource by type and UUID, optionally performing a dry run

DELETE/api/v1/deletion/{resourceType}/{resourceUuid}

Operation ID

DeleteResource

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

  • resourceType
    StringRequired

    Type of the resource to delete

  • resourceUuid
    StringRequired

    UUID of the resource to delete

Query Parameters

  • propagationPolicy
    String

    Deletion propagation policy, e.g. Foreground or Background Deletion propagation policy, e.g. Foreground or Background

  • dryRun
    Boolean

    Whether to simulate the deletion without actually deleting Whether to simulate the deletion without actually deleting

    Example: true

  • operator
    String

    Account name or ID of the operator initiating the deletion Account name or ID of the operator initiating the deletion

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"
  }
}