cPanel API 2 Functions - RoR::removerewrite

Description

This function removes a rewrite from a Ruby application.

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

 LiveAPI PHP Class

$cpanel new CPANEL(); // Connect to cPanel - only do this once.
  
// Removes a rewrite from the Ruby app "Test"
$remove_rewrite $cpanel->api2(
    'RoR''removerewrite',
 array(
        'appname' => 'Test',
        'rewritedomain' => 'example.com',
        'rewriteurl' => 'test',
 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
# Removes a rewrite the Ruby app "Test"
my $remove_rewrite $cpliveapi->api2(
    'RoR''setuprewrite',
{
        'appname' => 'Test',
        'rewritedomain' => 'example.com',
        'rewriteurl' => 'test',
   }
);

 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.


 Output (JSON)

{
  "cpanelresult": {
    "apiversion"2,
    "func""removerewrite",
    "data": [
      {
        "appname""test3",
        "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 (Home >> Advanced >> API Shell) to directly test cPanel API calls.

 

Parameters

Return

Type

Description

Possible values

Example

appname

 string 

Required

The Ruby application's name.

A valid string.

Test

 rewritedomain 

string

Required

The Ruby application's domain.

 A valid domain name. 

 example.com 

rewriteurl

string

Required

 The Ruby application's rewrite location. 

A valid string.

test

 

Returns

Return

Type

Description

Possible values

Example

appname

string

The Ruby application's name.

A valid string.

Test

domain

string

The domain name.

A valid domain.

example.com

statusmsg

string

Ruby's status.

  • Added Rewrite
  • error

Added Rewrite

status

boolean

Whether the function succeeded.

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

0

 rewritebasepath 

string

The application's absolute file path.

A valid path.

 /home/example/public_html 

url

string

 The application's web path, relative to the home directory. 

A valid file path.

test

port

integer

The application's port number.

A positive integer.

12001

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue 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

 

  • 15 Users Found This Useful
Was this answer helpful?

Related Articles

The cPanel Interface

For  cPanel  &  WHM  version  58 Overview The cPanel interface is...

User Preferences

For cPanel & WHM version 58 Overview This document outlines how to access your cPanel...

Manage External Authentications

For cPanel & WHM version 58 Overview Manage credentials Additional documentation...

What is cPanelID?

In This Article:  Overview ServicesHow to get a cPanelID cPanelID External...

Guide to cPanel Interface Customization - cPanel Style Development

Introduction You can develop custom styles that modify the appearance of the cPanel interface....