You can find our user documentation at

Check out our new API beta site!

Child pages
  • cPanel API 2 Functions - RoR::listrewrites
Skip to end of metadata
Go to start of metadata


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.


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


In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.




 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'


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',


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


 cPanel Tag System (deprecated)


  • In cPanel & WHM version 11.30 and later, 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


  • You must URI-encode values.
  • username represents your account-level username.
  • You must run the --user=username command.
  • 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:


 Output (JSON)
  "cpanelresult": {
    "apiversion": 2,
    "func": "listrewrites",
    "data": [
        "appname": "Test",
        "domain": "",
        "rewritebasepath": "/home/example/public_html",
        "url": "testruby",
        "port": "12001"
    "event": {
      "result": 1
    "module": "RoR"


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


This function does not accept parameters.


ReturnTypeDescriptionPossible valuesExample
appnamestringThe application's name.A valid string.Test
domainstringThe domain name.A valid domain
rewritebasepathstringThe path to the directory that contains the .htaccess file which contains the rewrite.A valid absolute directory path.
urlstringThe URL appendage to the rewrite.A valid path.testruby
portintegerThe application's port number.A positive integer.

A reason for failure.


This function only returns a reason value if it failed.

A string that describes the error.

This is an error message.

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.