v1

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

Stop an application's server process.

This function stops an application's server process.

Important:

This function only applies to applications in the server category. Calling it on a static application fails with the invalid_category error category.

get/WebApp/stop

Query parameters

namestring required
Example:my-app

The application's unique name (slug).

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": "stop",
  "module": "WebApp",
  "result": {
    "data": {
      "status": "stopped"
    },
    "status": 1
  }
}