# cPanel API 2 Functions - RoR::listrewrites

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) 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](https://docs.cpanel.net/knowledge-base/cpanel-product/cpanel-deprecation-plan/) documentation.
  - To install Ruby and create Ruby web applications, follow the directions in our [How to Create Ruby Web Applications](https://docs.cpanel.net/knowledge-base/web-services/how-to-create-ruby-web-applications/) documentation.
  - To register and manage Ruby applications, use the functions in UAPI `PassengerApps` module functions.


div
Important:

When you disable the [*Web Server* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


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

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

div
Note:

For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


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

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

div
Note:

For more information, read our [Guide to the LiveAPI System](/guides/guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

div
Warnings:

- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username RoR listrewrites
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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"
  }
}
```

div
Note:

Use cPanel's *[API Shell](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
appname
td
em
string
td
The application's name.
td
A valid string.
td
code
Test
tr
td
code
domain
td
em
string
td
The domain name.
td
A valid domain name.
td
code
example.com
tr
td
code
rewritebasepath
td
em
string
td
The path to the directory that contains the 
code
.htaccess
 file which contains the rewrite.
td
A valid absolute directory path.
td
code
/home/example/public_html
tr
td
code
url
td
em
string
td
The URL appendage to the rewrite.
td
A valid path.
td
code
testruby
tr
td
code
port
td
em
integer
td
The application's port number.
td
A positive integer.
td
code
12001
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
div
Note:

p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1