cPanel API 2 Functions - Mime::redirectname

Warning:

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

Description

This function echoes the domain name or ** All Public Domains **.

Warning:

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

Mime::redirect_info — This function retrieves redirect information for a URL or ** All Public Domains ** .

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=redirectname&domain=example.com

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.

// Reply with domain name or ** All Public Domains **
$redirect_name = $cpanel->api2(
    'Mime', 'redirectname',
    array(
        'domain'     => 'example.com',
  )
);

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.

# Reply with domain name or ** All Public Domains **
my $redirect_name = $cpliveapi->api2(
    'Mime', 'redirectname',
    {
        'domain'     => 'example.com',
 }
);

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 redirectname domain=example.com

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": "redirectname",
    "data": [
      {
        "domain": "example.com",
        "url": null
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Mime"
  }
}

Note:

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

Parameters

Parameter Type Description Possible values Example

Parameter	Type	Description	Possible values	Example
`domain`	string	Required The domain name.	A valid domain name.	`example.com`

domain

string

Required

The domain name.

A valid domain name.

example.com

Returns

Return	Type	Description	Possible values	Example
`domain`	string	The domain name.	The `domain` parameter.	`1`
`url`	string	We deprecated this parameter in cPanel & WHM 11.	`null`	`null`
`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`