Delete project
Changed onDelete an existing project in your workspace, identified by its id.
Deletion is asynchronous and eventually consistent. The project and all of its associated resources (apps, environments, deployments, custom domains) are torn down by a background workflow. A successful response indicates the deletion was enqueued, not that every resource has already been removed.
Projects with delete protection enabled cannot be deleted until protection is disabled.
Required Permissions
Your root key must have one of the following permissions:
- project.*.delete_project (to delete any project)
- project.<project_id>.delete_project (to delete a specific project)
Request
- Base URLhttps://api.unkey.com
- URLhttps://api.unkey.com/v2/projects.deleteProject
- AuthHTTP bearer
Request body
Example request
{
"project": "proj_1234abcd"
}Response
Successfully enqueued deletion of the project.
Example response
{
"meta": {
"requestId": "req_123"
}
}Changes
- info
the endpoint scheme security
bearerwas added to the API - info
the endpoint scheme security
rootKeywas removed from the API
- info
- breaking
removed the success response with the status
- info
added the success response with the status
- breaking