# Register Passenger application

This function registers a Passenger application for an account.

:

  * This function  registers an application. It does  create the application. You  create an application  you register the application. For an example of how to do this, read our How to Create Ruby Web Applications documentation.
  * When you disable the Web Server role, the system  this function.

Endpoint: GET /PassengerApps/register_application
Version: 11.134.0.5
Security: BasicAuth

## Query parameters:

  - `domain` (string, required)
    The domain for which to register the application.
    Example: "dorothy.com"

  - `name` (string, required)
    The application’s name.
    Example: "Name of Application"

  - `path` (string, required)
    The application’s filepath relative to the user’s home directory.
    Example: "/slippers"

  - `base_uri` (string)
    The application’s base URI.
    Example: "/ruby"

  - `deployment_mode` (string)
    The type of server environment in which to run the application.

  *  — Sets the application to run in a development environment.
  *  — Sets the application to run in a production environment.
    Enum: "production", "development"

  - `enabled` (integer)
    Whether to enable the application and generate the web server configuration for it.

  *  — Enable the application and generate the web server configuration.
  *  — Don’t enable the application and generate the web server configuration.
    Enum: 0, 1

  - `envvar_name` (array)
    Environment variables that the application needs.

:

  For each  parameter you send, you  include an  parameter.

  This parameter's value can only contain letters, numbers, underscores, and dashes, and cannot begin with a number. This parameter's value must also not exceed 256 characters.
    Example: ["SHOES","TINMAN"]

  - `envvar_value` (array)
    Each environment variable’s value.

:

  For each  parameter you send, you  include an  parameter.

  An environment variable value must contain 1024 or fewer ASCII-printable characters.
    Example: ["ruby","heart"]

## Response 200 fields (application/json):

  - `apiversion` (integer)
    The version of the API.
    Example: 3

  - `func` (string)
    The name of the method called.
    Example: "register_application"

  - `module` (string)
    The name of the module called.
    Example: "PassengerApps"

  - `result` (object)

  - `result.data` (object)
    An object describing the newly-registered application.
    Example: {"Name of Application":{"base_uri":"/ruby","deployment_mode":"production","domain":"dorothy.com","enabled":1,"envvars":{"SHOES":"ruby","TINMAN":"heart"},"name":"Name of Application","path":"/home/dorothy/slippers"}}

  - `result.errors` (array,null)
    List of errors if the API failed.

  - `result.messages` (array,null)
    List of messages generated by the API.

  - `result.metadata` (object)

  - `result.status` (integer)
    -  — Success.
-  — Failed. Check the  field for more details.
    Enum: 0, 1

  - `result.warnings` (array,null)
    List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.