• Support
  • cPanel & WHM Documentation
  • Developer Forums
  • Discord
    • Nothing Found
  • Support
  • cPanel & WHM Documentation
  • Developer Forums
  • Discord
    cPanel UAPI
      Guide to cPanel UAPI
      cPanel UAPI
      Authentication
      API Development Tools
      API Token Management
      Batch
      SSE Task Management
      URL Parsing
      Authentication
      External Authentication
      Two-Factor Settings
      Block Ip Addresses
      Block IP
      Commerce Integration
      Market Integration
      SSL Certificates
      cPanel Account
      Account Information
      Contact Information
      cPanel Features
      Disk Quotas
      Personalization
      Resource Usage and Statistics
      Subaccount Management
      cPanel Account Backups
      Backup
      File Restoration
      Restore
      cPanel Theme Management
      Application Information
      Brand Management
      Browser Cache Management
      Language
      Style Settings
      Theme Settings
      Directory Management
      Directory Indexes
      Directory Privacy
      Directory Protection
      DNS
      DNS Information
      DNS Security
      Dynamic DNS
      Email DNS Settings
      Domain Management
      Direct Link Protection (Hotlink)
        get
        Enable hotlink protection
        get
        Disable hotlink protection
        get
        Return domains with hotlink protection
      Domain Information
      Domain Redirection
      SubDomain
      Virtual Host Information
      Email
      Email
      Email Accounts
      Email Filtering
      Email Forwarding
      Email Server Information
      Email Suspensions
      Mail Filtering
      Mail Server Information
      Mailbox Management
      Mailing Lists
      Signing and Encryption (GnuPG Keys)
      Spam Filtering (Greylisting)
      Spam Management
      Spam Prevention (BoxTrapper)
      Webmail Applications
      Webmail Sessions
      Files
      FTP Accounts
      FTP Server Settings
      Image Tools
      Manage Files
      WebDisk Settings
      GIT Management
      Deployment Settings
      Repository Management
      MySQL and MariaDB
      Database Management
      Mysql
      Remote Databases
      Server Information
      User Management
      Notifications
      Pushbullet
      NVData
      NVData
      Optional Applications
      Antivirus Protection (ClamAV)
      Calendar and Contacts (DAV)
      Calendar and Contacts Server
      cPanel Addons (cPAddons)
      WordPress Manager Backups
      WordPress Manager Settings
      PostgreSQL
      Database Management
      User Management
      Retrieve bandwidth information
      Bandwidth
      Security
      Known SSH Hosts Management
      Login Information
      Server Information
      Notifications
      Password Strength
      Server Information
      SSH
      Variables
      SSL Certificates
      Auto-generated SSL Certificates
      Auto-generated SSL Certificates
      cPanel Account SSL Management
      SNI Email Settings
      SSL Certificate Management
      Verify Domain Ownership
      Statistics
      Domain Statistics
      Weblog Settings
      Web Server Management
      Application Manager
      ModSecurity
      PHP Settings
      Website Configuration
      Direct Link Protection (Hotlink)
        get
        Enable hotlink protection
        get
        Disable hotlink protection
        get
        Return domains with hotlink protection
      Handler Management
      Logs
      Mime
        get
        Add web server MIME type handler
        get
        Enable hotlink protection
        get
        Add MIME type to web server
        get
        Add redirect to domain
        get
        Remove web server MIME type handler
        get
        Disable hotlink protection
        get
        Remove MIME type from web server
        get
        Remove redirect from domain
        get
        Return redirect URL for domain
        get
        Return web server's MIME handlers
        get
        Return domains with hotlink protection
        get
        Return web server's MIME types
        get
        Return .htaccess files' redirects
      Mime Type Management
      Site Publisher Management
    WHM API1

Return domains with hotlink protection

This function lists domains with hotlink protection.

Important:

When you disable the Web Server role, the system disables this function.

Authorizations:
BasicAuth

Responses

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object

A server running cPanel.

https://{host}:{port}/execute/Mime/list_hotlinks

Request samples

  • CLI
  • URL
  • LiveAPI Perl
  • LiveAPI PHP
uapi --user=username Mime list_hotlinks

Response samples

  • 200
Content type
application/json
{
  • "apiversion": 3,
  • "func": "list_hotlinks",
  • "module": "Mime",
  • "result": {
    • "data": {
      • "allow_null": 1,
      • "extensions": "jpg,jpeg,gif,png,bmp",
      • "redirect_url": "http://redirect.example.com/",
      • "state": "disabled",
      • "urls": [
        • "http://example.com/"
        ]
      },
    • "errors": null,
    • "messages": null,
    • "metadata": { },
    • "status": 1,
    • "warnings": null
    }
}
Next to Return web server's MIME types
©2021 cPanel, L.L.C. All rights reserved.Privacy PolicyTrademarks