Child pages
  • UAPI Functions - Mime::add_hotlink

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

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

Panel
bgColor#F2F2F2
borderStylenone

Panel
bgColor#FFFFFF
borderStylenone
Expand
titlecPanel or Webmail Session URL
Code Block
languagetext
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

Include Page
LIB:_CallUAPIFromBrowserLink
LIB:_CallUAPIFromBrowserLink

Expand
titleLiveAPI PHP Class
Code Block
languagephp
linenumberstrue
$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/',
  )
);

Include Page
LIB:_LiveAPIPHPLink
LIB:_LiveAPIPHPLink

Expand
titleLiveAPI Perl Module
Code Block
languageperl
linenumberstrue
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/',
    }
);

Include Page
LIB:_LiveAPIPerlLink
LIB:_LiveAPIPerlLink

Expand
titlecPanel Template Toolkit
Code Block
languagexml
<!--  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/', } ); %]

Include Page
LIB:_TTLink
LIB:_TTLink

Expand
titleCommand Line
Code Block
languagetext
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

Include Page
LIB:_UAPICLINote
LIB:_UAPICLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
  "messages": null,
  "errors": null,
  "status": 1,
  "data": null
}

Include Page
LIB:_cPanelAPIShellNote
LIB:_cPanelAPIShellNote

ParameterTypeDescriptionPossible valuesExample
urlsstring

Required

The site to hotlink protect.

A valid URL.

Note
titleNote:

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
titleNote:

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.