DELETE: Delete an instance

This topic provides instructions for using the DELETE operation to delete an instance, or a specific entity.

Overview

To delete an instance, send an HTTP DELETE request on the instance resource or filtered collection. On success, only status code 200 (OK) is returned.

Caution: It is possible to delete all instances in a collection. Make sure you specify the instance ID or filter the collection.

Examples

The following examples show how to delete entities.

Delete a defect

*** Request ***

DELETE .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/2005

*** Response ***

HTTP/1.1 200 OK

Delete a workspace

This example demonstrates how a space admin can delete workspace 1036 in the space context.

You must include the delete_workspace_reason parameter in the delete workspace request.

Bulk deletion of workspaces is not supported.

DELETE .../api/shared_spaces/1001/workspaces/1036?delete_workspace_reason='test environment'

For an example of how to see the history of deleted workspaces, see GET request for history of deleted workspaces.