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

This function adds hotlink protection for a site. Hotlink protection will redirect users to another URL if they navigate to a file with a specified extension, but an allowed URL did not refer them.

Important:

In cPanel & WHM version 76 and later, when you disable the WebServer role, the system disables this function. For more information, read our How to Use Server Profiles documentation.


 cPanel or Webmail Session URL
https://hostname.example.com:2083/cpsess##########/execute/Mime/add_hotlink?urls=http%3A%2F%2Fexample.com%2F&extensions=foo&allow_null=1&redirect_url=http%3A%2F%2Fredirect.example.com%2F


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.
 
// Add a hotlink protection for extension ".foo"
$mime_add_hotlink_protection = $cpanel->uapi(
    'Mime', 'add_hotlink',
    array(
        'extensions'   => 'foo',
        'urls'         => 'http://example.com/',
        'allow_null'   => '1',
        'redirect_url' => 'http://redirect.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.
 
# Add a hotlink protection for extension ".foo"
my $mime_add_hotlink_protection = $cpliveapi->uapi(
    'Mime', 'add_hotlink',
    {
        'extensions'   => 'foo',
        'urls'         => 'http://example.com/',
        'allow_null'   => '1',
        'redirect_url' => 'http://redirect.example.com/',
    }
);


Note:

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

 cPanel Template Toolkit
<!--  Add a hotlink protection for extension ".foo" -->
[% data = execute( 'Mime', 'add_hotlink', {'extensions'=> 'foo', 'urls' => 'http://example.com/', 'allow_null' => '1', 'redirect_url' => 'http://redirect.example.com/', } ); %]


Note:

For more information, read our Guide to Template Toolkit documentation. 

 Command Line
uapi --user=username add_hotlink urls=http%3A%2F%2Fexample.com%2F extensions=foo allow_null=1 redirect_url=http%3A%2F%2Fredirect.example.com%2F


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": null
}


Note:

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

ParameterTypeDescriptionPossible valuesExample
urlsstring

Required

The site to hotlink protect.

A valid URL.

Note:

To protect multiple URLs, separate each URL with a newline character.

http://example.com/
extensionsstring

Required

File types to hotlink protect.

A valid file extension.

Note:

To protect multiple file types, use a comma-separated list.

foo
allow_nullBooleanWhether the domain allows hotlinks.
  • 1 — Allows.
  • 0 — Does not allow.
 1
redirect_urlstring

Required

The URL to which the system sends hotlinkers.

A valid URL.
http://redirect.example.com/

This function only returns metadata.