Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
PassengerApps
Application Manager

Update Passenger application settings

This function edits a Passenger application for an account.

Note:

When you disable the Web Server role, the system disables this function.

get/PassengerApps/edit_application

Query parameters

namestring required
Example:Ruby Slippers

The application’s current name.

clear_envvars0 | 1

Whether to clear the application’s environment variables.

deployment_mode'production' | 'development'
Example:production

The new server environment in which to run the application. If you do not use this parameter, the function does not change the application’s server environment.

  • development — Sets the application to run in a development environment.
  • production — Sets the application to run in a production environment.
domainstring domain
Example:toto.com

The application’s new domain. If you do not use this parameter, the function does not change the application’s domain.

enabled0 | 1
Example:1

Whether to enable the application and generate the web server configuration for it.

  • 1 — Enable the application and generate the web server configuration.
  • 0 — Don’t enable the application and generate the web server configuration.
envvar_namestring[]

New set of environment variables for the application.

Important:

The function replaces all current environment variables with the variables that you pass in this parameter.

Note:

For each envvar_name parameter you send you must include an envvar_value parameter.

[
  "SCARECROW",
  "TINMAN",
  "LION"
]
envvar_valuestring[]

Each environment variable’s value.

Note:

For each envvar_name parameter you send you must include an envvar_value parameter.

[
  "brain",
  "heart",
  "courage"
]
new_namestring
Example:Little Dog

The application’s new name. If you do not use this parameter, the function does not change the application's name.

pathstring path
Example:/home/dorothy/littledog

The application’s new filepath. If you do not use this parameter, the function does not change the application’s filepath.

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": "edit_application",
  "module": "PassengerApps",
  "result": {
    "status": 1
  }
}