cPanel API 2 Functions - RoR::listrewrites - Knowledgebase

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 strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

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

LiveAPI PHP Class

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

// List Ruby rewrites

$list_rewrites = $cpanel->api2(

'RoR', 'listrewrites'

);

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

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use theLiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read ourDeprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username RoR listrewrites

Notes:

You must URI-encode values.
username represents your account-level username.

Output (JSON)

Note:

Use cPanel's API Shell interface (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

Knowledgebase

Categories

Categories