Skip to main content

​
Overview

Removes/deletes an existing project from Dokploy. This operation is destructive and will permanently delete the project and all associated resources.
This operation is destructive and irreversible. All environments, applications, databases, and other services associated with this project will be permanently deleted.

​
Annotations

​
destructiveHint
boolean
default:"true"
This operation permanently deletes a project and all its resources. Use with caution.
​
idempotentHint
boolean
default:"false"
This operation is not idempotent - attempting to delete an already deleted project will result in an error.
​
openWorldHint
boolean
default:"true"
This operation interacts with the external Dokploy API.

​
Input Schema

​
projectId
string
required
The ID of the project to remove. Must be a valid existing project ID.

​
Response Schema

Returns a success confirmation:
​
message
string
Confirmation message indicating the project was removed successfully
​
data
object
Response data from the Dokploy API confirming the deletion

​
Usage Example

// Remove a project by ID
const result = await mcp.useTool("project-remove", {
  projectId: "proj_abc123"
});

console.log(result);
// Output:
// {
//   "message": "Project \"proj_abc123\" removed successfully",
//   "data": {
//     "success": true,
//     "deletedAt": "2024-03-04T15:30:00Z"
//   }
// }

​
Error Handling

If the project removal fails, an error response will be returned: 
{
  "error": "Failed to remove project",
  "details": "Project with ID \"proj_abc123\" not found"
}
Common error scenarios:
  • Project ID does not exist
  • Insufficient permissions to delete the project
  • Project has active resources that cannot be deleted
  • Network or API connection issues

​
Notes

  • This operation is permanent and irreversible
  • All environments associated with the project will be deleted
  • All applications, databases, and compose services within the project will be permanently removed
  • All domains and configurations will be deleted
  • Make sure to backup any important data before removing a project
  • Consider using project-one to review the project contents before deletion
  • You cannot undo this operation - deleted projects cannot be recovered

Build docs developers (and LLMs) love

Get started for freeTalk to us