---
title: "Return domains with hotlink protection"
method: GET
path: "/Mime/list_hotlinks"
tags: ["Mime", "Direct Link Protection (Hotlink)"]
---

# Return domains with hotlink protection

`GET /Mime/list_hotlinks`

This function lists domains with hotlink protection.

**Important:**

When you **disable** the [Web Server](https://go.cpanel.net/serverroles) role, the system **disables** this function.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `allow_null` 0 | 1 — Whether the domain allows hotlinks from an empty or null referral URL. * `1` - Allows hotlinks. * `0` - Does not allow hotlinks.
      - `extensions` string — A comma-separated list of file types to hotlink protect.
      - `redirect_url` string, url — The URL to which to send hotlinkers.
      - `state` 'enabled' | 'disabled' — Whether hotlink protection is enabled. * `enabled` * `disabled`
      - `urls` string[] — An array of the domains with hotlink protection.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 0 | 1 — * `1` - Success. * `0` - Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)