cPanel API 2 Functions - Mime::list_hotlinks

Warning:

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

Description

This function lists redirects from the cPanel account's .htaccess files.

Warning:

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

Mime::list_hotlinks

— This function lists domains with hotlink protection.

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=list_hotlinks

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 redirections from .htaccess files
$list_hotlinks = $cpanel->api2(
    'Mime', 'listhotlinks'
);

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 redirections from .htaccess files
my $list_hotlinks = $cpliveapi->api2(
    'Mime', 'listhotlinks',
);

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 listhotlinks

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": "list_hotlinks",
    "data": [
      {
        "extensions": "jpg,jpeg,gif,png,bmp",
        "allow_null": 0,
        "redirect_url": null,
        "urls": [
          "http://example.com",
          "http://www.example.com"
        ],
        "state": "disabled"
      }
    ],
    "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

Return	Type	Description	Possible values	Example
`extensions`	string	The file extensions with hotlink protection.	File extensions in a comma-separated list.	`jpg,jpeg,gif,png,bmp`
`allow_null`	Boolean	Whether hotlink protection allows direct requests.	`1` — Allows direct requests. `0` — Denies direct requests.	`1`
`redirect_null`	string	The destination URL.	A valid URL, or `null`.	`null`
`urls`	string	A list of URLs with hotlink protection.	A list of valid URLs.	`http://www.example.com`
`state`	string	Whether hotlink protection is enabled.	`enabled` `disabled`	`enabled`
`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`