v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

WebApp

Web Apps

Set an application's run mode.

This function sets an application's run mode and restarts the application so the new mode takes effect.

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/set_mode

Query parameters

mode'production' | 'development' required

Example:development

The run mode to set.

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": "set_mode",
  "module": "WebApp",
  "result": {
    "data": {
      "mode": "development",
      "restarted": 1
    },
    "status": 1
  }
}