We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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

This function removes 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/delete_hotlink


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.
 
// Remove hotlink protection from the site.
$mime_delete_hotlink = $cpanel->uapi(
    'Mime', 'delete_hotlink'
);


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.
 
# Remove hotlink protection from the site.
my $mime_hotlink = $cpliveapi->uapi(
    'Mime', 'delete_hotlink',
);


Note:

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


 Command Line
uapi --user=username Mime delete_hotlink


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.

This function does not accept parameters.

This function only returns metadata.