cPanel API 2 Functions - RoR::listrewrites

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists all of the mod_rewrite changes for the account's Ruby on Rails application. For more information on mod_rewrite, read The Apache Software Foundation's documentation.

Warning:

We deprecated the legacy Ruby codebase. For more information, read our cPanel Deprecation Plan documentation.
- To install Ruby and create Ruby web applications, follow the directions in our How to Create Ruby Web Applications documentation.
- To register and manage Ruby applications, use the functions in UAPI PassengerApps module functions.

Important:

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

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess###########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=RoR&cpanel_jsonapi_func=listrewrites

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// List Ruby rewrites
$list_rewrites = $cpanel->api2(
    'RoR', 'listrewrites'
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# List Ruby rewrites
my $list_rewrites = $cpliveapi->api2(
    'RoR', 'listrewrites',
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username RoR listrewrites

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listrewrites",
    "data": [
      {
        "appname": "Test",
        "domain": "example.com",
        "rewritebasepath": "/home/example/public_html",
        "url": "testruby",
        "port": "12001"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "RoR"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
`appname`	string	The application's name.	A valid string.	`Test`
`domain`	string	The domain name.	A valid domain name.	`example.com`
`rewritebasepath`	string	The path to the directory that contains the `.htaccess` file which contains the rewrite.	A valid absolute directory path.	`/home/example/public_html`
`url`	string	The URL appendage to the rewrite.	A valid path.	`testruby`
`port`	integer	The application's port number.	A positive integer.	`12001`
`reason`	string	A reason for failure. Note: This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`