cPanel API 2 Functions - Mime::redirectname - Knowledgebase

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 **.

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

 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',
  )
);

 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',
 }
);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI 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 our Deprecated 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": "redirectname",
    "data": [
      {
        "domain": "example.com",
        "url": null
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Mime"
  }
}

Note:

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

Parameters

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

Parameter

Type

Description

Possible values

Example

domain

string

Required

The domain name.

A valid domain name.

example.com

Returns

Parameter	Type	Description	Possible values	Example
domain	string	The domain.	The domain parameter.	1
url	string	This parameter is deprecated.	null	null
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

Knowledgebase

Categories

Categories