Enable hotlink protection

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:

When you disable the WebServer role, the system disables this function.

SecurityBasicAuth

Request

query Parameters

extensions required	string File types to hotlink protect. Note: To protect multiple file types, use a comma-separated list. Examples: Add hotlink protection for multiple file extensions. extensions=foo,bar Add hotlink protection for a single file extension. extensions=foo
redirect_url required	string <url> The URL to which the system sends hotlinkers. Example: redirect_url=http://redirect.example.com/
urls required	string The site to hotlink protect. Note: To protect multiple URLs, separate each URL with a newline character. Examples: Add hotlink protection for multiple sites. urls=http://example.com/ http://foobar.com/ Add hotlink protection for a single site. urls=http://example.com/
allow_null	integer Whether the domain allows hotlinks. `1` - Allows. `0` - Does not allow. Enum: 0 1 Example: allow_null=1

Responses

200

HTTP Request was successful.

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

get/Mime/add_hotlink

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  Mime \
  add_hotlink \
  urls='http://example.com/' \
  extensions='foo' \
  redirect_url='http://redirect.example.com/'

Response samples

application/json

{"apiversion": 3,
"func": "add_hotlink",
"module": "Mime",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}