v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
WebApp
Web Apps

Delete an application.

This function deletes an application: it stops the application's running process and removes its container, moves the application's directory aside to a .bak sibling (kept for verification or rollback rather than deleted), and removes the application from the account's registry.

Deleting an application cannot be undone, so it requires an explicit confirmation: verify must be 1 to proceed. A verify of 0 makes no changes and returns a confirmation-required error.

The application's domain is not affected; subdomains are managed independently.

On failure, the metadata.error_category field carries a machine-readable failure category.

Important:

The verify parameter is required and has no default. You must set it to 1 to confirm this irreversible operation.

get/WebApp/delete

Query parameters

namestring required
Example:my-app

The application's unique name (slug).

verify0 | 1 required
Example:1

Confirmation that this irreversible deletion should proceed.

  • 1 — Confirm and delete: the container is torn down and the application's directory is moved aside to <name>.bak (kept for verification or rollback, not hard-deleted).
  • 0 — Make no changes; the call returns a confirmation-required error.

This parameter is required and has no default.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "delete",
  "module": "WebApp",
  "result": {
    "data": {
      "removed": 1
    },
    "status": 1
  }
}