hostingaccount::set_suspended_url

Description

Set redirect URL for when a given hosting account is suspended

A suspended hosting account's website will redirect all requests to a predefined 'hosting account suspended' URL.

This will override, for a given hosting account, whatever the account-wide default may be as specified through account::set_suspended_url.

Request details

Arguments

key
API key
domain
Hosting account domain name
url
Redirect URL to use

Responses

<?xml version="1.0" encoding="utf-8"?>
<success>true</success>
	

Exceptions

Examples

Set redirect url for test01.example.com to http://example.com/suspended/

POST /account/set_suspended_url/
key=acbd18db4cc2f85cedef654fccc4a4d8
&domain=http://test01.example.com
&url=http://example.com/suspended/
<?xml version="1.0" encoding="utf-8"?>
<success>true</success>
	

See also

  1. Index
  2. About the API

    1. Summary
    2. Specification
    3. Do not use undocumented features
    4. Change log
  3. Using the API

    1. Requests
      1. Authenticated requests
      2. Limits
      3. Common request value data types
    2. Understanding responses
      1. HTTP status codes used
      2. Exceptions
        1. access
        2. account
        3. database
        4. hostingaccount
        5. server
        6. system
  4. Function reference