CPcpanel
WebApp
Web Apps

Stop an application's server process.

Changed on

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. It also requires the application to have finished at least one deploy; calling it before then fails with the not_deployed error category.

get/WebApp/stop

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

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
  }
}

Changes