Skip to main content
API Explorer|API Explorer
Infrastructure/Resource Deletion
DELETEDeletionSince 1.0SynchronousAuth Required

DeleteResource

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • resourceTypeStringRequired

    Type of the resource to delete

  • resourceUuidStringRequired

    UUID of the resource to delete

Query Parameters

  • propagationPolicyString

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

  • dryRunBoolean

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

    Example: true

  • operatorString

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

Responses

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

Endpoint

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

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

Operation ID

DeleteResource

Permalink

Request Example

curl -X DELETE '{host}/api/v1/deletion/{resourceType}/{resourceUuid}' -H 'Authorization: Bearer {token}'

Response Example

200
{}

Change History

This API has no change history records yet.

View all change history