cPanel API 2 Functions - Mime::listredirects

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function lists the cPanel account's redirects.

Warning:

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

Mime::list_redirects

— This function lists the redirects in an account's .htaccess files.

Important:

When you disable the Web Server role,the system disables this function.

Examples

WHM API (JSON)

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

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.

// List account redirections
$list_redirects = $cpanel->api2(
    'Mime', 'listredirects'
);

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.

# List account redirections
my $list_redirects = $cpliveapi->api2(
    'Mime', 'listredirects',
);

Note:

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

cPanel Tag System (deprecated)

Warnings:

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

Notes:

You must URI-encode values.
username represents your account-level username.
You must run the --user=username option.
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": "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"
  }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Parameter	Type	Description	Possible values	Example
`source`	string	The part of the URL after the domain to redirect.	A path and a document name.	`/index.html`
`targeturl`	string	The redirection destination.	A valid URL.	`http://destination.example.com/`
`destination`	string	The redirection destination.	A valid URL.	`http://destination.example.com/`
`displaydomain`	string	The domain part of the URL to redirect.	A valid domain.	`http://www.example.com/`
`displaysourceurl`	string	The part of the URL after the domain to redirect.	A path and a document name.	`/index.html`
`kind`	string	The kind of redirection.	`rewrite` is the only possible value.	`rewrite`
`domain`	string	The domain to redirect.	A valid domain	`example.com`
`wildcard_text`	string	Whether the wildcard checkbox is selected.	`checked` — A wildcard redirection. `unchecked` — Not a wildcard redirection.	`checked`
`matchwww`	Boolean	Whether the redirection handles the www. subdomain in addition to the domain.	`1` — Redirect the www. subdomain. `0` — Do not redirect the `www`. subdomain.	`1`
`docroot`	string	The document root for the source domain.	A valid path.	`/home/example/public_html`
`opts`	string	The options that the function passes to Apache as part of the Rewrite Rule.	A valid Rewrite rule.	`L`
`wildcard`	Boolean	Whether to redirect all files within a directory to the same filename in the redirected directory.	`1` — A wildcard redirection. `0` — Not a wildcard redirection.	`1`
`urldomain`	string	The domain to redirect.	A valid domain.	`example.com`
`sourceurl`	string	The 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`
`type`	string	The type of redirection.	`permanent` — A permanent redirection. `temporary` — A temporary redirection.	`permanent`
`reason`	string	A reason for failure. 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`