Deleting projects

Delete an existing project.

Before you begin

  • You need an admin access to delete a project.
  • If you do not have admin access but have a custom role, ensure that you have the write access specifically for the project.

About this task

Important: The deletion is irreversible. Once deleted, the project and all its associated data, including workflows, flow services, and assets, are permanently removed.

Procedure

  1. In a REST client platform, add the authentication details of the tenant that is associated with the project you want to delete. 
    
//In case of Instance API key 
Headers:
{
"x-instance-api-key": "instance_api_key"
}
 
// In case of MCSP or ISV token
Headers:
{
"Authorization": "Bearer mcsp_or_isv_token"
}
  2. Optional: You can forcefully delete a project and all its assets by sending a request with the following body, along with the authentication details for the tenant linked to the project. 
    
//In case of Instance API key 
Headers:
{
"x-instance-api-key": "instance_api_key"
}
 
// In case of MCSP or ISV token
Headers:
{
"Authorization": "mcsp_or_isv_token"
}
Body: 
{
"force_delete": true,
"confirm_project_name": "Delete <project_name>"
}
    Note: Ensure the value for the confirm_project_name key matches Delete <project_name>, including the correct case. The project name must match with the original name.
  3. Make a DELETE request at the URL of the project.

    URL Syntax: <domain>/apis/v1/rest/projects/:project

    In this URL request, /:project is the UID or name of the project you want to delete.

    Method: DELETE

    If the request is successful, you receive the response code for success. 
    {
 output: 
		{
		message: "Project deleted successfully."
		}
}