Child pages
  • cPanel API 2 Functions - RoR::removerewrite

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function removes a rewrite from a Ruby application.

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIsLegacyRubyDeprecated
PageWithExcerptLIB:_Ruby via mod_passenger Warnings

Multiexcerpt include
SpaceWithExcerptcom.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptNameAPIDisabledWebServerRole
PageWithExcerptLIB:_ServerRoleDisabledAPI

Panel
bgColor#F2F2F2
borderStylenone

Examples


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleWHM API (JSON)


Code Block
languagetext
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

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$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',
 )  
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

 


Expand
titleLiveAPI Perl Module


Code Block
languageperl
linenumberstrue
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',
   }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

 


Expand
titlecPanel Tag System (deprecated)

Include Page
LIB:_cPanelAPI2cPanelTagsWarning
LIB:_cPanelAPI2cPanelTagsWarning


Expand
titleCommand Line


Code Block
languagebash
cpapi2 --user=username RoR setuprewrite appname=Test rewritedomain=example.com rewriteurl=test

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
linenumberstrue
{
  "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"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


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 directory that contains the application.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
titleNote:

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