# cPanel API 2 Functions - Mime::list_hotlinks

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](https://api.docs.cpanel.net/cpanel/introduction) 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](/cpanel/introduction/) function instead of this function:

- [`Mime::list_hotlinks`](/openapi/cpanel/operation/list_hotlinks/)


- This function lists domains with hotlink protection.


Important:
When you disable the [*Web Server* role](https://docs.cpanel.net/knowledge-base/general-systems-administration/how-to-use-server-profiles/#roles), the system **disables** this function.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username Mime listhotlinks
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
{
  "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*](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel) interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
extensions
td
em
string
td
The file extensions with hotlink protection.
td
p
File extensions in a comma-separated list.
td
code
jpg,jpeg,gif,png,bmp
tr
td
code
allow_null
td
em
Boolean
td
Whether hotlink protection allows direct requests.
td
ul
li
p
code
1
 — Allows direct requests.
li
p
code
0
 — Denies direct requests.
td
code
1
tr
td
code
redirect_null
td
em
string
td
The destination URL.
td
 A valid URL, or 
code
null
.
td
code
null
tr
td
code
urls
td
em
string
td
 A list of URLs with hotlink protection.
td
 A list of valid URLs.
td
code
http://www.example.com
tr
td
code
state
td
em
string
td
Whether hotlink protection is enabled.
td
ul
li
p
code
enabled
li
p
code
disabled
td
code
enabled
tr
td
code
reason
td
em
string
td
div
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1