You can find our user documentation at docs.cpanel.net.

Check out our new API beta site!

Child pages
  • UAPI Functions - Mime::list_hotlinks
Skip to end of metadata
Go to start of metadata

This function lists domains with hotlink protection.

Important:

In cPanel & WHM version 76 and later, when you disable the Web Server role, the system disables this function.


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/list_hotlinks


Note:

This example calls the UAPI function via a cPanel session. For more information, read our Guide to UAPI documentation. 

 LiveAPI PHP Class
$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
 
// List domains with hotlink protection.
$mime_list_hotlinks = $cpanel->uapi(
    'Mime', 'list_hotlinks'
);


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 domains with hotlink protection.
my $mime_list_hotlinks = $cpliveapi->uapi(
    'Mime', 'list_hotlinks',
);


Note:

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

 Command Line
uapi --user=username Mime list_hotlinks


Notes:

  • You must URI-encode values.
  • username represents your account-level username.
  • For more information and additional output options, read our Guide to UAPI documentation or run the uapi --help command. 
  • If you run CloudLinux™, you must use the full path of the uapi command:

    /usr/local/cpanel/bin/uapi


 Output (JSON)
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": {
    "extensions": "jpg,jpeg,gif,png,bmp",
    "allow_null": 0,
    "redirect_url": null,
    "urls": [
      "http://example.com",
      "http://www.example.com"
    ],
    "state": "disabled"
  }
}


Note:

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

This function does not accept parameters.

ReturnTypeDescriptionPossible valuesExample
urlsarray

A list of the domains with hotlink protection.

An array of one or more valid URLs.


http://example.com/
extensionsstring

File types to hotlink protect.

A comma-separated list of valid file extensions.

jpg,jpeg,gif,png,bmp
allow_nullBooleanWhether the domain allows hotlinks from an empty or null referral URL.
  • 1 — Allows hotlinks.
  • 0 — Does not allow hotlinks.
 1
redirect_urlstring

The URL to which to send hotlinkers.

A valid URL.
http://redirect.example.com/
statestringWhether hotlink protection is enabled.
  • enabled
  • disabled
disabled