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

Description

This function adds a rewrite for a Ruby application.

Warning:

  • 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.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.

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=setuprewrite&appname=Test&rewritedomain=example.com&rewriteurl=test


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.
 
// Adds a rewrite the Ruby app "Test"
$add_rewrite = $cpanel->api2(
    'RoR', 'setuprewrite',
 array(
        'appname'       => 'Test',
        'rewritedomain' => 'example.com',
        'rewriteurl'    => 'test',
 )  
);


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.
 
# Adds a rewrite the Ruby app "Test"
my $add_rewrite = $cpliveapi->api2(
    'RoR', 'setuprewrite',
{ 
        'appname'       => 'Test',
        'rewritedomain' => 'example.com',
        'rewriteurl'    => 'test',
   }
);


Note:

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

 

 cPanel Tag System (deprecated)


Warnings:

  • 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 setuprewrite appname=Test rewritedomain=example.com rewriteurl=test


Notes:

  • 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:

    /usr/local/cpanel/bin/cpapi2

 Output (JSON)
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "setuprewrite",
    "data": [
      {
        "appname": "Test",
        "domain": "example.com",
        "statusmsg": "Added Rewrite",
        "status": 1,
        "rewritebasepath": "/home/example/public_html",
        "url": "test",
        "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

ReturnTypeDescriptionPossible valuesExample
appnamestring

Required

The Ruby application's name.

A valid string.

Test
rewritedomainstring

Required

The Ruby application's domain.

A valid domain name.example.com
rewriteurlstring

Required

The Ruby application's rewrite location.

A valid string.test

Returns

ReturnTypeDescriptionPossible valuesExample
appnamestringThe Ruby application's name.A valid string.Test
domainstringThe domain name.A valid domain.
example.com
statusmsgstringRuby's status.
  • Added Rewrite
  • error
Added Rewrite
statusBoolean

Whether the function succeeded.

  • 1 — The function succeeded.
  • 0 — The function failed.
0
rewritebasepath
stringThe application's directory path.An absolute directory path.
/home/example/public_html
urlstringThe application's web path.A valid file path, relative to the account's home web directory.test
portintegerThe application's port number.A positive integer.12001
reasonstring

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.
resultBoolean

Whether the function succeeded.

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