projects

Delete 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)
post/v2/projects.deleteProject

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/projects.deleteProject
  • Auth
    HTTP bearer

Request body

projectstring required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Example request

{
  "project": "proj_1234abcd"
}

Response

Successfully enqueued deletion of the project.

dataEmptyResponse required

Empty response object by design. A successful response indicates this operation was successfully executed.

Example response

{
  "meta": {
    "requestId": "req_123"
  }
}

Changes

    • info

      the endpoint scheme security bearer was added to the API

    • info

      the endpoint scheme security rootKey was removed from the API

    • breaking

      removed the success response with the status

    • info

      added the success response with the status