Child pages
  • cPanel API 2 Functions - Mime::listredirects

Versions Compared

Key

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

 

Description

Excerpt

This function lists the cPanel account's redirects.


Warning
titleWarning:

We strongly recommend that you use the following UAPI function instead of this function:

  • Mime::list_redirects

    Excerpt Include
    DD:UAPI Functions - Mime::list_redirects
    DD:UAPI Functions - Mime::list_redirects
    nopaneltrue

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=Mime&cpanel_jsonapi_func=listredirects

Include Page
LIB:_CallFromWHMAPILink
LIB:_CallFromWHMAPILink


Expand
titleLiveAPI PHP Class


Code Block
languagephp
linenumberstrue
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List account redirections
$list_redirects = $cpanel->api2(
    'Mime', 'listredirects'
);

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.
 
# List account redirections
my $list_redirects = $cpliveapi->api2(
    'Mime', 'listredirects',
);

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 Mime listredirects

Include Page
LIB:_cPanelAPI2CLINote
LIB:_cPanelAPI2CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "cpanelresult": {
    "apiversion": 2,
    "func": "listredirects",
    "data": [
      {
        "source": "\/test2",
        "targeturl": "http://test2.example.com/",
        "destination": "http://test2.example.com/",
        "displaydomain": "ALL",
        "displaysourceurl": "/test2",
        "kind": "rewrite",
        "domain": ".*",
        "wildcard_text": "checked",
        "matchwww": 1,
        "docroot": "/home/example/public_html",
        "opts": "L",
        "wildcard": 1,
        "urldomain": "example.com",
        "sourceurl": "/test2",
        "matchwww_text": "checked",
        "type": "temporary"
      },
      {
        "source": "/test",
        "targeturl": "http://test.example.com/",
        "destination": "http://test.example.com/",
        "displaydomain": "example.com",
        "displaysourceurl": "/test",
        "kind": "rewrite",
        "domain": "example.com",
        "wildcard_text": "",
        "matchwww": 1,
        "docroot": "/home/example/public_html",
        "opts": "L",
        "wildcard": 0,
        "urldomain": "example.com",
        "sourceurl": "/test",
        "matchwww_text": "checked",
        "type": "permanent"
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Mime"
  }
}


Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote


Parameters

This function does not accept parameters.

Returns

ParameterTypeDescriptionPossible valuesExample
sourcestringThe part of the URL after the domain to redirect.A path and a document name./index.html
targeturlstringThe redirection destination.A valid URL.http://destination.example.com/
destinationstringThe redirection destination.A valid URL.http://destination.example.com/
displaydomainstringThe domain part of the URL to redirect.A valid domain.http://www.example.com/
displaysourceurlstringThe part of the URL after the domain to redirect.A path and a document name./index.html
kindstringThe kind of redirection.rewrite is the only possible value.rewrite
domainstringThe domain to redirect.A valid domainexample.com
wildcard_textstringWhether the wildcard checkbox is selected.
  • checked — A wildcard redirection.
  • uncheckedNot a wildcard redirection.
checked
matchwwwBooleanWhether the redirection handles the www. subdomain in addition to the domain.
  • 1 — Redirect the www. subdomain.
  • 0 — Do not redirect the www. subdomain.
1
docrootstringThe document root for the source domain.A valid path./home/example/public_html
optsstringThe options that the function passes to Apache as part of the Rewrite Rule.A valid Rewrite rule.L
wildcardBooleanWhether to redirect all files within a directory to the same filename in the redirected directory.
  • 1 — A wildcard redirection.
  • 0Not a wildcard redirection.
1
urldomainstringThe domain to redirect.A valid domain.example.com
sourceurlstringThe location that will redirect visitors.A valid URL.http://www.example.com/index.html
matchwww_text string Whether the redirection handles the www. subdomain in addition to the domain.
  • checked — Redirect the www. subdomain.
  • unchecked— Do not redirect the www. subdomain.
checked
typestringThe type of redirection.
  • permanent — A permanent redirection.
  • temporary — A temporary redirection.
permanent
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