:original_name: DeleteWorkspace.html

.. _DeleteWorkspace:

Deleting a Workspace
====================

Function
--------

This API is used to delete a workspace.

URI
---

DELETE /v1/{project_id}/workspaces/{workspace_id}

.. table:: **Table 1** Path parameters

   +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
   | Parameter    | Mandatory | Type   | Description                                                                                                        |
   +==============+===========+========+====================================================================================================================+
   | project_id   | Yes       | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID <modelarts_03_0147>`. |
   +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+
   | workspace_id | Yes       | String | Workspace ID.                                                                                                      |
   +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+

Request Parameters
------------------

None

Response Parameters
-------------------

**Status code: 200**

.. table:: **Table 2** Response body parameters

   +--------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
   | Parameter    | Type   | Description                                                                                                                 |
   +==============+========+=============================================================================================================================+
   | workspace_id | String | Workspace ID, which is a 32-bit UUID generated by the system without hyphens (-). The ID of the default workspace is **0**. |
   +--------------+--------+-----------------------------------------------------------------------------------------------------------------------------+

Example Requests
----------------

Deleting a Workspace

.. code-block:: text

   DELETE https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}

Example Responses
-----------------

**Status code: 200**

OK

.. code-block::

   {
     "workspace_id" : "***05d1a553b4e188ea878e7dcb85***"
   }

Status Codes
------------

=========== ===================
Status Code Description
=========== ===================
200         OK
400         BadRequest
403         Forbidden
500         InternalServerError
=========== ===================

Error Codes
-----------

See :ref:`Error Codes <modelarts_03_0095>`.